MEDMEM.FAMILY Class Reference

#include <MEDMEM_Family.hxx>

Inheritance diagram for MEDMEM.FAMILY:

Public Member Functions
	FAMILY ()
	FAMILY (GMESH *Mesh, int Identifier, string Name, int NumberOfAttribute, int *AttributeIdentifier, int *AttributeValue, string AttributeDescription, int NumberOfGroup, string GroupName, int *MEDArrayNodeFamily, int **MEDArrayCellFamily, int **MEDArrayFaceFamily, int **MEDArrayEdgeFamily)
	FAMILY (const FAMILY &m)
	FAMILY (const SUPPORT &s)
FAMILY &	operator= (const FAMILY &fam)
bool	build (MED_EN::medEntityMesh Entity, int **FamilyNumber)
void	setIdentifier (int Identifier)
void	setNumberOfAttributes (int NumberOfAttribute)
void	setAttributesIdentifiers (int *AttributeIdentifier)
void	setAttributesValues (int *AttributeValue)
void	setAttributesDescriptions (std::string *AttributeDescription)
void	setNumberOfGroups (int NumberOfGroups)
void	setGroupsNames (std::string *GroupName, bool giveOwnership=false)
int	getIdentifier () const
int	getNumberOfAttributes () const
const int *	getAttributesIdentifiers () const
const int *	getAttributesValues () const
const std::string *	getAttributesDescriptions () const
int	getNumberOfGroups () const
const std::string *	getGroupsNames () const
int	getAttributeIdentifier (int i) const
int	getAttributeValue (int i) const
std::string	getAttributeDescription (int i) const
std::string	getGroupName (int i) const
Protected Member Functions
virtual	~FAMILY ()
Protected Attributes
int	_identifier
int	_numberOfAttribute
PointerOf< int >	_attributeIdentifier
PointerOf< int >	_attributeValue
std::vector< std::string >	_attributeDescription
int	_numberOfGroup
std::vector< std::string >	_groupName
Friends
std::ostream &	operator<< (std::ostream &os, FAMILY &my)
std::ostream &	operator<< (std::ostream &os, const FAMILY &my)

---

Constructor & Destructor Documentation

FAMILY::~FAMILY

(

)

[protected, virtual]

Destructor.

References MESSAGE_MED.

FAMILY::FAMILY

(

)

Constructor.

References MESSAGE_MED.

FAMILY::FAMILY	(	GMESH *	Mesh,
		int	Identifier,
		string	Name,
		int	NumberOfAttribute,
		int *	AttributeIdentifier,
		int *	AttributeValue,
		string	AttributeDescription,
		int	NumberOfGroup,
		string	GroupName,
		int *	MEDArrayNodeFamily,
		int **	MEDArrayCellFamily,
		int **	MEDArrayFaceFamily,
		int **	MEDArrayEdgeFamily
	)

References MEDMEM.FAMILY._attributeDescription, MEDMEM.FAMILY._attributeIdentifier, MEDMEM.FAMILY._attributeValue, MEDMEM.SUPPORT._description, MEDMEM.SUPPORT._entity, MEDMEM.SUPPORT._geometricType, MEDMEM.FAMILY._groupName, MEDMEM.FAMILY._identifier, MEDMEM.SUPPORT._isOnAllElts, MEDMEM.SUPPORT._mesh, MEDMEM.FAMILY._numberOfAttribute, MEDMEM.SUPPORT._numberOfElements, MEDMEM.SUPPORT._numberOfGeometricType, MEDMEM.FAMILY._numberOfGroup, MEDMEM.SUPPORT._totalNumberOfElements, MEDMEM.FAMILY.build(), MEDMEM.SUPPORT.getDescription(), MEDMEM.SUPPORT.getEntity(), MEDMEM.SUPPORT.getMesh(), MEDMEM.SUPPORT.getName(), MEDMEM.SUPPORT.getNumber(), MEDMEM.SUPPORT.getNumberOfElements(), MEDMEM.GMESH.getNumberOfElements(), MEDMEM.GMESH.getNumberOfNodes(), MEDMEM.SUPPORT.getNumberOfTypes(), MEDMEM.SUPPORT.getTypes(), MEDMEM.SUPPORT.isOnAllElements(), MED_EN.MED_ALL_ELEMENTS, MED_EN.MED_CELL, MED_EN.MED_EDGE, MED_EN.MED_FACE, MED_EN.MED_NODE, MED_EN.MED_NONE, MED_TAILLE_DESC, MED_TAILLE_LNOM, MESSAGE_MED, SCRUTE_MED, MEDMEM.PointerOf< T >.set(), MEDMEM.SUPPORT.setMesh(), MEDMEM.SUPPORT.setName(), MEDMEM.SUPPORT.setNumber(), and MEDMEM.SUPPORT.update().

FAMILY::FAMILY

(

const FAMILY &

m

)

Copy Constructor.

References MEDMEM.FAMILY._attributeDescription, MEDMEM.FAMILY._attributeIdentifier, MEDMEM.FAMILY._attributeValue, MEDMEM.FAMILY._groupName, MEDMEM.FAMILY._identifier, MEDMEM.FAMILY._numberOfAttribute, MEDMEM.FAMILY._numberOfGroup, MESSAGE_MED, and MEDMEM.PointerOf< T >.set().

FAMILY::FAMILY

(

const SUPPORT &

s

)

Constructor with SUPPORT entry.

References MEDMEM.FAMILY._identifier, MEDMEM.FAMILY._numberOfAttribute, MEDMEM.FAMILY._numberOfGroup, and MESSAGE_MED.

---

Member Function Documentation

FAMILY & FAMILY::operator=

(

const FAMILY &

fam

)

References MEDMEM.FAMILY._attributeDescription, MEDMEM.FAMILY._attributeIdentifier, MEDMEM.FAMILY._attributeValue, MEDMEM.FAMILY._groupName, MEDMEM.FAMILY._identifier, MEDMEM.FAMILY._numberOfAttribute, MEDMEM.FAMILY._numberOfGroup, MESSAGE_MED, and MEDMEM.PointerOf< T >.set().

bool FAMILY::build	(	MED_EN::medEntityMesh	Entity,
		int **	FamilyNumber
	)

References MEDMEM.SUPPORT._entity, MEDMEM.SUPPORT._geometricType, MEDMEM.FAMILY._identifier, MEDMEM.SUPPORT._isOnAllElts, MEDMEM.SUPPORT._mesh, MEDMEM.SUPPORT._numberOfElements, MEDMEM.SUPPORT._numberOfGeometricType, MEDMEM.SUPPORT._totalNumberOfElements, MEDMEM.GMESH.getNumberOfElements(), MEDMEM.GMESH.getNumberOfTypes(), MEDMEM.GMESH.getTypes(), MED_EN.MED_ALL_ELEMENTS, MED_EN.MED_CELL, MESSAGE_MED, medMeshing_test.numberOfTypes, SCRUTE_MED, MEDMEM.PointerOf< T >.set(), MEDMEM.SUPPORT.setNumber(), medClient_test.types, and MEDMEM.SUPPORT.update().

void MEDMEM.FAMILY::setIdentifier

(

int

Identifier

)

Sets the attribute _identifier to Identifier.

References MEDMEM.FAMILY._identifier.

void MEDMEM.FAMILY::setNumberOfAttributes

(

int

NumberOfAttribute

)

Sets the attribute _numberOfAttribute to NumberOfAttribute.

References MEDMEM.FAMILY._numberOfAttribute.

void MEDMEM.FAMILY::setAttributesIdentifiers

(

int *

AttributeIdentifier

)

Sets the attribute _attributeIdentifier to AttributeIdentifier.

References MEDMEM.FAMILY._attributeIdentifier, and MEDMEM.PointerOf< T >.setShallowAndOwnership().

void MEDMEM.FAMILY::setAttributesValues

(

int *

AttributeValue

)

Sets the attribute _attributeValue to AttributeValue.

References MEDMEM.FAMILY._attributeValue, and MEDMEM.PointerOf< T >.setShallowAndOwnership().

void MEDMEM.FAMILY::setAttributesDescriptions

(

std::string *

AttributeDescription

)

Sets the attribute _attributeDescription to AttributeDescription.

References MEDMEM.FAMILY._attributeDescription, and MEDMEM.FAMILY.getNumberOfAttributes().

void MEDMEM.FAMILY::setNumberOfGroups

(

int

NumberOfGroups

)

Sets the attribute _numberOfGroup to NumberOfGroups.

References MEDMEM.FAMILY._numberOfGroup.

void MEDMEM.FAMILY::setGroupsNames	(	std::string *	GroupName,
		bool	giveOwnership = false
	)

Sets the attribute _groupName to GroupName.

References MEDMEM.FAMILY._groupName, and MEDMEM.FAMILY.getNumberOfGroups().

int MEDMEM.FAMILY::getIdentifier

(

)

const

Returns the attribute _identifier.
Note that there is one identifier precisely for each family.

References MEDMEM.FAMILY._identifier.

int MEDMEM.FAMILY::getNumberOfAttributes

(

)

const

Returns the number of attributes of the family.

References MEDMEM.FAMILY._numberOfAttribute.

const int * MEDMEM.FAMILY::getAttributesIdentifiers

(

)

const

Returns a pointer to attributes identifiers . (There are _numberOfAttribute attributes)

References MEDMEM.FAMILY._attributeIdentifier.

const int * MEDMEM.FAMILY::getAttributesValues

(

)

const

Returns a pointer to attributes values. (There are _numberOfAttribute attributes)

References MEDMEM.FAMILY._attributeValue.

const std::string * MEDMEM.FAMILY::getAttributesDescriptions

(

)

const

References MEDMEM.FAMILY._attributeDescription.

int MEDMEM.FAMILY::getNumberOfGroups

(

)

const

Returns the number of groups the family belongs to.

References MEDMEM.FAMILY._numberOfGroup.

const std::string * MEDMEM.FAMILY::getGroupsNames

(

)

const

Returns a pointer to the names of the groups the family belongs to

References MEDMEM.FAMILY._groupName.

int MEDMEM.FAMILY::getAttributeIdentifier

(

int

i

)

const

Returns identifer of the Ith attribute of the family.
Note that they are numbered from 1 to N

int MEDMEM.FAMILY::getAttributeValue

(

int

i

)

const

Returns value of the Ith attribute of the family.
Note that they are numbered from 1 to N

std::string MEDMEM.FAMILY::getAttributeDescription

(

int

i

)

const

Returns description of the Ith attribute of the family
Note that they are numbered from 1 to N

std::string MEDMEM.FAMILY::getGroupName

(

int

i

)

const

Returns the name of the Ith group the family belongs to.
Note that they are numbered from 1 to N

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		FAMILY &	my
	)		[friend]

std::ostream& operator<<	(	std::ostream &	os,
		const FAMILY &	my
	)		[friend]

---

Field Documentation

int MEDMEM.FAMILY._identifier [protected]

int MEDMEM.FAMILY._numberOfAttribute [protected]

PointerOf<int> MEDMEM.FAMILY._attributeIdentifier [protected]

PointerOf<int> MEDMEM.FAMILY._attributeValue [protected]

std::vector<std::string> MEDMEM.FAMILY._attributeDescription [protected]

int MEDMEM.FAMILY._numberOfGroup [protected]

std::vector<std::string> MEDMEM.FAMILY._groupName [protected]