multipr.Family Class Reference

#include <MULTIPR_Family.hxx>

Public Member Functions
	Family ()
	Builds an empty Family (default constructor).
	Family (const Family &pFamily)
	Copy constructor.
	~Family ()
	Destructor.
void	reset ()
	Resets this object in its state by default (empty).
med_int	getId () const
	Returns the identifier (= number) of this Family.
void	setId (med_int pId)
	Set the identifier of this family.
const char *	getName () const
	Returns the name of this Family.
bool	isFamilyOfNodes () const
	Returns true if this Family if a family of nodes, false if is a family of elements (=cells)).
void	setIsFamilyOfNodes (bool pIsFamilyOfNodes)
	Sets whether this Family is a family of nodes or family of elements (= cells).
void	insertElt (med_int pIndexElt, eMeshType pMeshIndex=eMED_POINT1)
	Inserts a new element (by its index) into this Family.
int	getSize (eMeshType pMeshIndex=eMED_POINT1) const
	Returns the number of elements in this Family.
void	buildGroups (std::vector< Group * > &pGroups, std::map< std::string, Group * > &pGroupNameToGroup) const
	Adds all the groups of this Family into the set of groups described by (pGroups, pGroupNameToGroup).
Family *	extractGroup (const char *pGroupName)
	Constructor.
const std::set< med_int > &	getSetOfElt (eMeshType pMeshIndex) const
	Returns the set of all the elements referenced in this Family.
void	readMED (med_idt pMEDfile, char *pMeshName, med_int pIndex)
	Reads a Family from a MED file.
void	writeMED (med_idt pMEDfile, char *pMeshName)
	Writes this Family to a MED file.
void	setPrintAll (bool pFlag)
	Sets the flag which control the stream operator <<.
Family &	operator= (const Family &)
	Flag to control the behaviour of the stream operator <<.
bool	operator== (const Family &)
Data Fields
char	mName [32+1]
med_int	mId
	Name of the Family.
std::set< med_int >	mElt [eMaxMedMesh]
	Set of all the elements (by their index in 1.
std::string	mStrNameGroups
	A string with name of all groups which contain the Family.
std::vector< std::string >	mNameGroups
	List of groups (by name) which contain the Family.
Attributs	mAttributs
	All the attributed related to the Family.
bool	mIsFamilyOfNodes
	Is it a family of nodes or a family of elements?
bool	mFlagPrintAll
Friends
std::ostream &	operator<< (std::ostream &pOs, Family &pF)
	Dumps any Family to the given output stream.

Constructor & Destructor Documentation

multipr.Family::Family ( )

Builds an empty Family (default constructor).

References multipr.Family.reset().

multipr.Family::Family ( const Family & pFamily )

Copy constructor.

References multipr.Family.mAttributs, MED_TAILLE_NOM, multipr.Family.mId, multipr.Family.mName, multipr.Family.mNameGroups, and multipr.Family.mStrNameGroups.

multipr.Family::~Family ( )

Destructor.

Removes everything.

References multipr.Family.reset().

Member Function Documentation

void multipr.Family::reset ( )

Resets this object in its state by default (empty).

Cleans memory.

References multipr.eMaxMedMesh, multipr.Family.mAttributs, multipr.Family.mElt, multipr.Family.mFlagPrintAll, multipr.Family.mId, multipr.Family.mIsFamilyOfNodes, multipr.Family.mName, multipr.Family.mNameGroups, multipr.Family.mStrNameGroups, and multipr.Attributs.reset().

med_int multipr.Family.getId ( void ) const

Returns the identifier (= number) of this Family.

Returns:: the identifier of this Family.

References multipr.Family.mId.

void multipr.Family.setId ( med_int pId )

Set the identifier of this family.

Parameters:

pId

The identifier.

References multipr.Family.mId.

const char* multipr.Family.getName ( ) const

Returns the name of this Family.

Returns:: the name of this Family.

References multipr.Family.mName.

bool multipr.Family.isFamilyOfNodes ( ) const

Returns true if this Family if a family of nodes, false if is a family of elements (=cells)).

Returns:: true iff this Family if a family of nodes.

References multipr.Family.mIsFamilyOfNodes.

void multipr.Family.setIsFamilyOfNodes ( bool pIsFamilyOfNodes )

Sets whether this Family is a family of nodes or family of elements (= cells).

Parameters:

pIsFamilyOfNodes

flag.

References multipr.Family.mIsFamilyOfNodes.

void multipr.Family::insertElt	(	med_int	pIndexElt,
		eMeshType	pMeshIndex = `eMED_POINT1`
	)

Inserts a new element (by its index) into this Family.

Parameters:

	pIndexElt	index of the element to be added; must be >= 1.
	pMeshIndex	Index of the mesh (eMED_TETRA4 etc...). Default value when its a family of nodes.

Exceptions:

IllegalArgumentException

if pIndexElt <= 0.

References multipr.Family.mElt.

int multipr.Family.getSize ( eMeshType pMeshIndex = eMED_POINT1 ) const

Returns the number of elements in this Family.

Returns:: the number of elements in this Family.

References multipr.Family.mElt.

void multipr.Family::buildGroups	(	std::vector< Group * > &	pGroups,
		std::map< std::string, Group * > &	pGroupNameToGroup
	)			const

Adds all the groups of this Family into the set of groups described by (pGroups, pGroupNameToGroup).

Parameters:

	pGroups	current list of groups.
	pGroupNameToGroup	table (map) to retrieve a Group* from its name.

References med_test1.begin, multipr.eMaxMedMesh, med_test1.group, multipr.Group.insertElt(), multipr.Family.isFamilyOfNodes(), Med_Gen_test.it, multipr.Family.mElt, multipr.Family.mNameGroups, NULL, multipr.Group.setIsGroupOfNodes(), and multipr.Group.setName().

Family * multipr.Family::extractGroup ( const char * pGroupName )

Constructor.

Returns a copy of this family restricted to the given group if pGroupName != NULL. Examples: 1. If current family have 3 groups "A", "B" and "C" and pGroupName="B", then the new family will only reference the group "B" 2. If current family have 3 groups "A", "B" and "C" and pGroupName="D", then the new family will reference groups "A", "B" and "C". WARNING: elements are not copied

Parameters:

pGroupName

name of the group to keep.