Back to index

salome-med  6.5.0
Public Member Functions
SALOME_MED::FAMILY Interface Reference

import "MED.idl";

Inheritance diagram for SALOME_MED::FAMILY:
Inheritance graph
[legend]
Collaboration diagram for SALOME_MED::FAMILY:
Collaboration graph
[legend]

List of all members.

Public Member Functions

long getIdentifier () raises (SALOME::SALOME_Exception)
 Returns Family identifier (Identifier of the family in the mesh).
long getNumberOfAttributes () raises (SALOME::SALOME_Exception)
 Returns number of attributes.
SALOME_TYPES::ListOfLong getAttributesIdentifiers () raises (SALOME::SALOME_Exception)
 Returns an array of all attributes' identifiers.
long getAttributeIdentifier (in long i) raises (SALOME::SALOME_Exception)
 Returns identifier of i-th attribute.
SALOME_TYPES::ListOfLong getAttributesValues () raises (SALOME::SALOME_Exception)
 Returns an array of all values of the attributes .
long getAttributeValue (in long i) raises (SALOME::SALOME_Exception)
 Returns the value of i-th attribute.
SALOME_TYPES::ListOfString getAttributesDescriptions () raises (SALOME::SALOME_Exception)
 Returns an array of all descriptions of the attributes .
string getAttributeDescription (in long i) raises (SALOME::SALOME_Exception)
 Returns the description of i-th attribute.
long getNumberOfGroups () raises (SALOME::SALOME_Exception)
 Returns the number of groups the family belongs to.
SALOME_TYPES::ListOfString getGroupsNames () raises (SALOME::SALOME_Exception)
 Returns an array of names of groups the family belongs to .
string getGroupName (in long i) raises (SALOME::SALOME_Exception)
 Returns the name of i-th group.
string getName () raises (SALOME::SALOME_Exception)
 Returns the name of the support.
string getDescription () raises (SALOME::SALOME_Exception)
 Returns the description of the support.
GMESH getMesh () raises (SALOME::SALOME_Exception)
 Returns a reference to the mesh.
medEntityMesh getEntity () raises (SALOME::SALOME_Exception)
 Returns the type of medEntityMesh used by the support.
boolean isOnAllElements () raises (SALOME::SALOME_Exception)
 Returns True if all elements of this entity are engaged, False otherwise.
long getNumberOfElements (in medGeometryElement geomElement) raises (SALOME::SALOME_Exception)
 If the method isOnAllElements() returns False, this method returns the number of elements in the support.
long getNumberOfTypes () raises (SALOME::SALOME_Exception)
medGeometryElement_array getTypes () raises (SALOME::SALOME_Exception)
 If isOnAllElements is False, returns an array of medGeometryElement types used by the support.
SALOME_TYPES::ListOfLong getNumber (in medGeometryElement geomElement) raises (SALOME::SALOME_Exception)
 If the method isOnAllElements() returns False, this method returns an array which contains all numbers of given medGeometryElement.
SALOME_TYPES::ListOfLong getNumberFromFile (in medGeometryElement geomElement) raises (SALOME::SALOME_Exception)
 If the method isOnAllElements() returns False, this method returns an array which contains all numbers of given medGeometryElement.
SALOME::SenderInt getSenderForNumber (in medGeometryElement geomElement) raises (SALOME::SALOME_Exception)
 Idem SALOME::Sender getNumber(in medGeometryElement geomElement) but returning Sender.
SALOME_TYPES::ListOfLong getNumberIndex () raises (SALOME::SALOME_Exception)
 If the method isOnAllElements() returns False, this method returns the index of element number.
SALOME::SenderInt getSenderForNumberIndex () raises (SALOME::SALOME_Exception)
 Idem SALOME_TYPES::ListOfLong getNumberIndex() but return a Sender.
void getBoundaryElements () raises (SALOME::SALOME_Exception)
 This method gets the boundary elements of the mesh.
long getCorbaIndex () raises (SALOME::SALOME_Exception)
 Internal Corba method.
supportInfos getSupportGlobal () raises (SALOME::SALOME_Exception)

Detailed Description

Definition at line 705 of file MED.idl.


Member Function Documentation

string SALOME_MED::FAMILY::getAttributeDescription ( in long  i) raises (SALOME::SALOME_Exception)

Returns the description of i-th attribute.

Note:
i is bounded by 1 and NumberOfAttributes.
int MEDMEM::FAMILY::getAttributeIdentifier ( in long  i) raises (SALOME::SALOME_Exception) [inline]

Returns identifier of i-th attribute.

Returns identifer of the Ith attribute of the family.

Note:
i is bounded by 1 and NumberOfAttributes.


Note that they are numbered from 1 to N

Definition at line 281 of file MEDMEM_Family.hxx.

{ 
    return _attributeIdentifier[i-1] ; 
}
const std::string * MEDMEM::FAMILY::getAttributesDescriptions ( ) raises (SALOME::SALOME_Exception) [inline]

Returns an array of all descriptions of the attributes .

There is one description for each attribute.

Definition at line 303 of file MEDMEM_Family.hxx.

{ 
    return &(_attributeDescription[0]);
}
SALOME_TYPES::ListOfLong SALOME_MED::FAMILY::getAttributesIdentifiers ( ) raises (SALOME::SALOME_Exception)

Returns an array of all attributes' identifiers.

There is one for each attribute.

SALOME_TYPES::ListOfLong SALOME_MED::FAMILY::getAttributesValues ( ) raises (SALOME::SALOME_Exception)

Returns an array of all values of the attributes .

There is one value for each attribute.

int MEDMEM::FAMILY::getAttributeValue ( in long  i) raises (SALOME::SALOME_Exception) [inline]

Returns the value of i-th attribute.

Returns value of the Ith attribute of the family.

Note:
i is bounded by 1 and NumberOfAttributes.


Note that they are numbered from 1 to N

Definition at line 297 of file MEDMEM_Family.hxx.

{ 
    return _attributeValue[i-1] ; 
}
long SALOME_MED::SUPPORT::getCorbaIndex ( ) raises (SALOME::SALOME_Exception) [inherited]

Internal Corba method.

string SALOME_MED::SUPPORT::getDescription ( ) raises (SALOME::SALOME_Exception) [inherited]

Returns the description of the support.

medEntityMesh SALOME_MED::SUPPORT::getEntity ( ) raises (SALOME::SALOME_Exception) [inherited]

Returns the type of medEntityMesh used by the support.

Note:
A support deals only with one entity's type (for example : MED_FACE or MED_NODE)
string SALOME_MED::FAMILY::getGroupName ( in long  i) raises (SALOME::SALOME_Exception)

Returns the name of i-th group.

Note:
i is bounded by 1 and NumberOfAttributes.
const std::string * MEDMEM::FAMILY::getGroupsNames ( ) raises (SALOME::SALOME_Exception) [inline]

Returns an array of names of groups the family belongs to .

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

There is one name for each group.

Definition at line 325 of file MEDMEM_Family.hxx.

{ 
  return &(_groupName[0]);
}
long SALOME_MED::FAMILY::getIdentifier ( ) raises (SALOME::SALOME_Exception)

Returns Family identifier (Identifier of the family in the mesh).

Note:
There is precisely only one indentifier for each family.
GMESH SALOME_MED::SUPPORT::getMesh ( ) raises (SALOME::SALOME_Exception) [inherited]

Returns a reference to the mesh.

string SALOME_MED::SUPPORT::getName ( ) raises (SALOME::SALOME_Exception) [inherited]

Returns the name of the support.

SALOME_TYPES::ListOfLong SALOME_MED::SUPPORT::getNumber ( in medGeometryElement  geomElement) raises (SALOME::SALOME_Exception) [inherited]

If the method isOnAllElements() returns False, this method returns an array which contains all numbers of given medGeometryElement.

Numbering is global, ie numbers are bounded by 1 and MESH::getNumberOfElement(entity,MED_ALL_ELEMENTS) and not by 1 and MESH::getNumberOfElement(entity,geomElement).

Note:
If SUPPORT is defined on MED_NODE, use MED_NONE medGeometryElement type.
const int * SUPPORT::getNumberFromFile ( in medGeometryElement  geomElement) raises (SALOME::SALOME_Exception) [inherited]

If the method isOnAllElements() returns False, this method returns an array which contains all numbers of given medGeometryElement.

Numbering is from file, ie numbers are bounded by 1 and MESH::getNumberOfElement(entity,MED_ALL_ELEMENTS) and not by 1 and MESH::getNumberOfElement(entity,geomElement).

Note:
If SUPPORT is defined on MED_NODE, use MED_NONE medGeometryElement type.

Definition at line 1605 of file MEDMEM_Support.cxx.

{
//   if (_isOnAllElts)
//     throw MEDEXCEPTION("Support::getNumberFromFile : Not defined, support is on all entity !") ;
  if (GeometricType==MED_EN::MED_ALL_ELEMENTS)
    return _number_fromfile->getValue() ;
  for (int i=0;i<_numberOfGeometricType;i++)
    if (_geometricType[i]==GeometricType)
      return _number_fromfile->getI(i+1) ;
  throw MEDEXCEPTION("Support::getNumberFromFile : GeometricType not found !") ;
}
SALOME_TYPES::ListOfLong SALOME_MED::SUPPORT::getNumberIndex ( ) raises (SALOME::SALOME_Exception) [inherited]

If the method isOnAllElements() returns False, this method returns the index of element number.

Use it with getNumber(MED_ALL_ELEMENTS).

Note:
See the method getConnectivityIndex for more details.
long SALOME_MED::FAMILY::getNumberOfAttributes ( ) raises (SALOME::SALOME_Exception)

Returns number of attributes.

long SALOME_MED::SUPPORT::getNumberOfElements ( in medGeometryElement  geomElement) raises (SALOME::SALOME_Exception) [inherited]

If the method isOnAllElements() returns False, this method returns the number of elements in the support.

Example : number of MED_TRIA3 or MED_ALL_ELEMETNS elements in entity of support.

Note:
If SUPPORT is defined on MED_NODE, use MED_NONE medGeometryElement type.
long SALOME_MED::FAMILY::getNumberOfGroups ( ) raises (SALOME::SALOME_Exception)

Returns the number of groups the family belongs to.

long SALOME_MED::SUPPORT::getNumberOfTypes ( ) raises (SALOME::SALOME_Exception) [inherited]
SALOME::SenderInt SALOME_MED::SUPPORT::getSenderForNumber ( in medGeometryElement  geomElement) raises (SALOME::SALOME_Exception) [inherited]

Idem SALOME::Sender getNumber(in medGeometryElement geomElement) but returning Sender.


It could be used in a Client code using the MED Client classes.

SALOME::SenderInt SALOME_MED::SUPPORT::getSenderForNumberIndex ( ) raises (SALOME::SALOME_Exception) [inherited]

Idem SALOME_TYPES::ListOfLong getNumberIndex() but return a Sender.


It could be used in a Client code using the MED Client classes.

supportInfos SALOME_MED::SUPPORT::getSupportGlobal ( ) raises (SALOME::SALOME_Exception) [inherited]
medGeometryElement_array SALOME_MED::SUPPORT::getTypes ( ) raises (SALOME::SALOME_Exception) [inherited]

If isOnAllElements is False, returns an array of medGeometryElement types used by the support.

medEntityMesh is given by getEntity.

boolean SALOME_MED::SUPPORT::isOnAllElements ( ) raises (SALOME::SALOME_Exception) [inherited]

Returns True if all elements of this entity are engaged, False otherwise.

If True, you must use mesh reference (getMesh) to get more information.


The documentation for this interface was generated from the following files: