Back to index

salome-smesh  6.5.0
Public Member Functions
SMESH::SMESH_Group Interface Reference

SMESH_Group: interface of a standalone group object. More...

import "SMESH_Group.idl";

Inheritance diagram for SMESH::SMESH_Group:
Inheritance graph
[legend]
Collaboration diagram for SMESH::SMESH_Group:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void Clear ()
 Clears the group's contents.
long Add (in long_array elem_ids)
 Adds elements or nodes with specified identifiers to the group.
long AddByPredicate (in Predicate thePredicate)
 Adds elements or nodes that match specified predicate to the group.
long AddFrom (in SMESH_IDSource theSource)
 Add all elements or nodes from the specified source to the group.
long Remove (in long_array elem_ids)
 Removes elements or nodes with specified identifiers from the group.
long RemoveByPredicate (in Predicate thePredicate)
 Removes elements or nodes that match specified predicate from the group.
void SetName (in string name)
 Sets group name.
string GetName ()
 Returns group name.
ElementType GetType ()
 Returns group type (type of elements in the group)
long Size ()
 Returns the number of elements in the group.
boolean IsEmpty ()
 Returns true if the group does not contain any elements.
boolean Contains (in long elem_id)
 returns true if the group contains an element with ID == <elem_id>
long GetID (in long elem_index)
 Returns ID of an element at position <elem_index>
long_array GetListOfID ()
 Returns a sequence of all element IDs in the group.
long GetNumberOfNodes ()
 Get the number of nodes of cells included to the group For a nodal group returns the same value as Size() function.
long_array GetNodeIDs ()
 Get IDs of nodes of cells included to the group For a nodal group returns result of GetListOfID() function.
boolean IsNodeInfoAvailable ()
 Return true if GetNumberOfNodes() won't take a long time for computation.
void SetColor (in SALOMEDS::Color theColor)
 Sets group color.
SALOMEDS::Color GetColor ()
 Returns group color.
void SetColorNumber (in long color)
 Sets group color number (corresponds to the "hue" parameter of the color - must be in range [0, 360])
long GetColorNumber ()
 Returns group color number (obsolete - use GetColor instead) (corresponds to the "hue" parameter of the color - must be in range [0, 360])
long_array GetIDs ()
 Returns a sequence of all element IDs.
long_array GetMeshInfo ()
 Returns statistic of mesh elements.
array_of_ElementType GetTypes ()
 Returns types of elements it contains.
SMESH_Mesh GetMesh ()
 Returns the mesh.
boolean IsMeshInfoCorrect ()
 Returns false if GetMeshInfo() returns incorrect information that may happen if mesh data is not yet fully loaded from the file of study.

Detailed Description

SMESH_Group: interface of a standalone group object.

Definition at line 129 of file SMESH_Group.idl.


Member Function Documentation

long SMESH::SMESH_Group::Add ( in long_array  elem_ids)

Adds elements or nodes with specified identifiers to the group.

long SMESH::SMESH_Group::AddByPredicate ( in Predicate  thePredicate)

Adds elements or nodes that match specified predicate to the group.

Add all elements or nodes from the specified source to the group.

Clears the group's contents.

boolean SMESH::SMESH_GroupBase::Contains ( in long  elem_id) [inherited]

returns true if the group contains an element with ID == <elem_id>

SALOMEDS::Color SMESH::SMESH_GroupBase::GetColor ( ) [inherited]

Returns group color.

Returns group color number (obsolete - use GetColor instead) (corresponds to the "hue" parameter of the color - must be in range [0, 360])

long SMESH::SMESH_GroupBase::GetID ( in long  elem_index) [inherited]

Returns ID of an element at position <elem_index>

Returns a sequence of all element IDs.

Returns a sequence of all element IDs in the group.

Returns the mesh.

Here is the caller graph for this function:

Returns statistic of mesh elements.

Returns:
array of number enityties by index of EntityType
string SMESH::SMESH_GroupBase::GetName ( ) [inherited]

Returns group name.

Here is the caller graph for this function:

Get IDs of nodes of cells included to the group For a nodal group returns result of GetListOfID() function.

Get the number of nodes of cells included to the group For a nodal group returns the same value as Size() function.

Returns group type (type of elements in the group)

Here is the caller graph for this function:

Returns types of elements it contains.

It's empty if the SMESH_IDSource contains no IDs

boolean SMESH::SMESH_GroupBase::IsEmpty ( ) [inherited]

Returns true if the group does not contain any elements.

Returns false if GetMeshInfo() returns incorrect information that may happen if mesh data is not yet fully loaded from the file of study.

Return true if GetNumberOfNodes() won't take a long time for computation.

long SMESH::SMESH_Group::Remove ( in long_array  elem_ids)

Removes elements or nodes with specified identifiers from the group.

Removes elements or nodes that match specified predicate from the group.

void SMESH::SMESH_GroupBase::SetColor ( in SALOMEDS::Color  theColor) [inherited]

Sets group color.

void SMESH::SMESH_GroupBase::SetColorNumber ( in long  color) [inherited]

Sets group color number (corresponds to the "hue" parameter of the color - must be in range [0, 360])

void SMESH::SMESH_GroupBase::SetName ( in string  name) [inherited]

Sets group name.

long SMESH::SMESH_GroupBase::Size ( ) [inherited]

Returns the number of elements in the group.


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