Version: 9.12.0
SMESH::SMESH_GroupOnFilter Interface Reference

SMESH_GroupOnFilter: interface of a group object defined by filter. More...

import"SMESH_Group.idl";

Inheritance diagram for SMESH::SMESH_GroupOnFilter:

Public Member Functions

void SetFilter (in Filter theFilter) raises (SALOME::SALOME_Exception)
 
Filter GetFilter ()
 
boolean IsUpToDate ()
 
void SetName (in string name)
 Sets group name. More...
 
string GetName ()
 Returns group name. More...
 
ElementType GetType ()
 Returns group type (type of elements in the group) More...
 
smIdType Size ()
 Returns the number of elements in the group. More...
 
boolean IsEmpty ()
 Returns true if the group does not contain any elements. More...
 
boolean Contains (in smIdType elem_id)
 returns true if the group contains an element with ID == <elem_id> More...
 
smIdType GetID (in smIdType elem_index)
 Returns ID of an element at position <elem_index> counted from 1. More...
 
smIdType_array GetListOfID ()
 Returns a sequence of all element IDs in the group. More...
 
smIdType GetNumberOfNodes ()
 Get the number of nodes of cells included to the group For a nodal group returns the same value as Size() function. More...
 
smIdType_array GetNodeIDs ()
 Get IDs of nodes of cells included to the group For a nodal group returns result of GetListOfID() function. More...
 
boolean IsNodeInfoAvailable ()
 Return true if GetNumberOfNodes() won't take a long time for computation. More...
 
void SetColor (in SALOMEDS::Color theColor)
 Sets group color. More...
 
SALOMEDS::Color GetColor ()
 Returns group color. More...
 
void SetColorNumber (in long color)
 Sets group color number (corresponds to the "hue" parameter of the color - must be in range [0, 360]) More...
 
long GetColorNumber ()
 Returns group color number (obsolete - use GetColor instead) (corresponds to the "hue" parameter of the color - must be in range [0, 360]) More...
 
boolean IsInDependency (in SMESH_GroupBase other)
 Returns true if this group depends on the other via FT_BelongToMeshGroup predicate or vice versa. More...
 
smIdType_array GetIDs ()
 Returns a sequence of all element IDs. More...
 
smIdType_array GetMeshInfo ()
 Returns number of mesh elements of each EntityType. More...
 
smIdType_array GetNbElementsByType ()
 Returns number of mesh elements of each ElementType. More...
 
array_of_ElementType GetTypes ()
 Returns types of elements it contains. More...
 
SMESH_Mesh GetMesh ()
 Returns the mesh. More...
 
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. More...
 
SALOMEDS::TMPFile GetVtkUgStream ()
 Returns mesh unstructed grid information. More...
 

Detailed Description

SMESH_GroupOnFilter: interface of a group object defined by filter.

Member Function Documentation

◆ Contains()

boolean SMESH::SMESH_GroupBase::Contains ( in smIdType  elem_id)
inherited

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

◆ GetColor()

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

Returns group color.

◆ GetColorNumber()

long SMESH::SMESH_GroupBase::GetColorNumber ( )
inherited

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

◆ GetFilter()

Filter SMESH::SMESH_GroupOnFilter::GetFilter ( )

◆ GetID()

smIdType SMESH::SMESH_GroupBase::GetID ( in smIdType  elem_index)
inherited

Returns ID of an element at position <elem_index> counted from 1.

◆ GetIDs()

smIdType_array SMESH::SMESH_IDSource::GetIDs ( )
inherited

Returns a sequence of all element IDs.

◆ GetListOfID()

smIdType_array SMESH::SMESH_GroupBase::GetListOfID ( )
inherited

Returns a sequence of all element IDs in the group.

◆ GetMesh()

SMESH_Mesh SMESH::SMESH_IDSource::GetMesh ( )
inherited

Returns the mesh.

◆ GetMeshInfo()

smIdType_array SMESH::SMESH_IDSource::GetMeshInfo ( )
inherited

Returns number of mesh elements of each EntityType.

Returns
array of number of elements per EntityType

◆ GetName()

string SMESH::SMESH_GroupBase::GetName ( )
inherited

Returns group name.

◆ GetNbElementsByType()

smIdType_array SMESH::SMESH_IDSource::GetNbElementsByType ( )
inherited

Returns number of mesh elements of each ElementType.

Returns
array of number of elements per ElementType

◆ GetNodeIDs()

smIdType_array SMESH::SMESH_GroupBase::GetNodeIDs ( )
inherited

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

◆ GetNumberOfNodes()

smIdType SMESH::SMESH_GroupBase::GetNumberOfNodes ( )
inherited

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

◆ GetType()

ElementType SMESH::SMESH_GroupBase::GetType ( )
inherited

Returns group type (type of elements in the group)

◆ GetTypes()

array_of_ElementType SMESH::SMESH_IDSource::GetTypes ( )
inherited

Returns types of elements it contains.

It's empty if the SMESH_IDSource contains no IDs

◆ GetVtkUgStream()

SALOMEDS::TMPFile SMESH::SMESH_IDSource::GetVtkUgStream ( )
inherited

Returns mesh unstructed grid information.

◆ IsEmpty()

boolean SMESH::SMESH_GroupBase::IsEmpty ( )
inherited

Returns true if the group does not contain any elements.

◆ IsInDependency()

boolean SMESH::SMESH_GroupBase::IsInDependency ( in SMESH_GroupBase  other)
inherited

Returns true if this group depends on the other via FT_BelongToMeshGroup predicate or vice versa.

◆ IsMeshInfoCorrect()

boolean SMESH::SMESH_IDSource::IsMeshInfoCorrect ( )
inherited

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

◆ IsNodeInfoAvailable()

boolean SMESH::SMESH_GroupBase::IsNodeInfoAvailable ( )
inherited

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

◆ IsUpToDate()

boolean SMESH::SMESH_GroupOnFilter::IsUpToDate ( )
Returns
True if group contents is computed

◆ SetColor()

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

Sets group color.

◆ SetColorNumber()

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])

◆ SetFilter()

void SMESH::SMESH_GroupOnFilter::SetFilter ( in Filter  theFilter)
raises (SALOME::SALOME_Exception
)

◆ SetName()

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

Sets group name.

◆ Size()

smIdType SMESH::SMESH_GroupBase::Size ( )
inherited

Returns the number of elements in the group.