multipr.Group Class Reference

#include <MULTIPR_Family.hxx>

Public Member Functions
	Group ()
	Builds an empty group (default constructor).
	~Group ()
	Destructor.
void	reset ()
	Resets this object in its state by default (empty).
bool	isGroupOfNodes () const
	Returns true if it is a group of nodes, false if it is a group of elements.
void	setIsGroupOfNodes (bool pIsGroupOfNodes)
	Sets whether it is a group of nodes or a group of elements.
const std::string &	getName () const
	Returns the name of this Group.
void	setName (const std::string &pName)
	Sets the name of this Group.
void	insertElt (med_int pIndexElt, eMeshType pMeshIndex)
	Adds the index of a new element to this Group.
void	setSetOfElt (eMeshType pMeshIndex, const std::set< med_int > &pSetOfElt)
	Set a complete set of elements.
const std::set< med_int > &	getSetOfElt (eMeshType pMeshIndex) const
	Returns the set of all the elements referenced in this Group.
int	getSize (eMeshType pMeshIndex) const
	Returns the number of elements referenced in this Group.
void	setPrintAll (bool pFlag)
	Sets the flag which control the stream operator <<.
	Group (const Group &)
	Flag to control the behaviour of the stream operator <<.
Group &	operator= (const Group &)
bool	operator== (const Group &)
Data Fields
std::string	mName
	Name of the group.
std::set< med_int >	mElt [eMaxMedMesh]
	All elements of this group; each element is referenced by its index >= 1; each element is unique.
bool	mIsGroupOfNodes
	Is it a group of nodes or a group of elements?
bool	mFlagPrintAll
Friends
std::ostream &	operator<< (std::ostream &pOs, Group &pG)
	Dumps any Group to the given output stream.

---

Constructor & Destructor Documentation

multipr.Group::Group

(

)

Builds an empty group (default constructor).

References multipr.Group.reset().

multipr.Group::~Group

(

)

Destructor.

Removes everything.

References multipr.Group.reset().

multipr.Group.Group

(

const Group &

)

Flag to control the behaviour of the stream operator <<.

---

Member Function Documentation

void multipr.Group::reset

(

)

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

Cleans memory.

References multipr.eMaxMedMesh, multipr.Group.mElt, multipr.Group.mFlagPrintAll, multipr.Group.mIsGroupOfNodes, and multipr.Group.mName.

bool multipr.Group.isGroupOfNodes

(

)

const

Returns true if it is a group of nodes, false if it is a group of elements.

Returns:

true if it is a group of nodes, false if it is a group of elements.

References multipr.Group.mIsGroupOfNodes.

void multipr.Group.setIsGroupOfNodes

(

bool

pIsGroupOfNodes

)

Sets whether it is a group of nodes or a group of elements.

Parameters:

pIsGroupOfNodes

true for a group of nodes, false for a group of elements.

References multipr.Group.mIsGroupOfNodes.

const std::string& multipr.Group.getName

(

)

const

Returns the name of this Group.

Returns:

the name of this Group.

References multipr.Group.mName.

void multipr.Group::setName

(

const std::string &

pName

)

Sets the name of this Group.

Parameters:

pName

new name of this Group (length of name must not exceed MED_TAILLE_LNOM).

References MED_TAILLE_LNOM, and multipr.Group.mName.

void multipr.Group::insertElt	(	med_int	pIndexElt,
		eMeshType	pMeshIndex
	)

Adds the index of a new element to this Group.

Parameters:

	pIndexElt	must be >= 1.
	pMeshIndex	The index of the mesh type.

References multipr.Group.mElt.

void multipr.Group.setSetOfElt	(	eMeshType	pMeshIndex,
		const std::set< med_int > &	pSetOfElt
	)

Set a complete set of elements.

Parameters:

	pMeshIndex	The index of the mesh type.
	pSetOfElt	The set of elements.

References multipr.Group.mElt.

const std::set<med_int>& multipr.Group.getSetOfElt

(

eMeshType

pMeshIndex

)

const

Returns the set of all the elements referenced in this Group.

Returns:

the set of all the elements referenced in this Group.

References multipr.Group.mElt.

int multipr.Group.getSize

(

eMeshType

pMeshIndex

)

const

Returns the number of elements referenced in this Group.

Returns:

the number of elements referenced in this Group.

References multipr.Group.mElt.

void multipr.Group.setPrintAll

(

bool

pFlag

)

Sets the flag which control the stream operator <<.

Parameters:

pFlag

new flag value.

References multipr.Group.mFlagPrintAll.

Group& multipr.Group.operator=

(

const Group &

)

bool multipr.Group.operator==

(

const Group &

)

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOs,
		Group &	pG
	)			[friend]

Dumps any Group to the given output stream.

Parameters:

	pOs	any output stream.
	pG	any Group.

Returns:

the output stream pOs.

---

Field Documentation

std::string multipr.Group.mName

Name of the group.

std::set<med_int> multipr.Group.mElt[eMaxMedMesh]

All elements of this group; each element is referenced by its index >= 1; each element is unique.

bool multipr.Group.mIsGroupOfNodes

Is it a group of nodes or a group of elements?

bool multipr.Group.mFlagPrintAll