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

import "SMESH_Group.idl";

Inheritance diagram for SMESH::SMESH_Group:

Public Member Functions
void	Clear ()
	Clears the group's contents. More...

long	Add (in long_array elem_ids)
	Adds elements or nodes with specified identifiers to the group. More...

long	AddByPredicate (in Predicate thePredicate)
	Adds elements or nodes that match specified predicate to the group. More...

long	AddFrom (in SMESH_IDSource theSource)
	Add all elements or nodes from the specified source to the group. More...

long	Remove (in long_array elem_ids)
	Removes elements or nodes with specified identifiers from the group. More...

long	RemoveByPredicate (in Predicate thePredicate)
	Removes elements or nodes that match specified predicate from the group. More...

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...

long	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 long elem_id)
	returns true if the group contains an element with ID == <elem_id> More...

long	GetID (in long elem_index)
	Returns ID of an element at position <elem_index> counted from 1. More...

long_array	GetListOfID ()
	Returns a sequence of all element IDs in the group. More...

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

long_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...

long_array	GetIDs ()
	Returns a sequence of all element IDs. More...

long_array	GetMeshInfo ()
	Returns number of mesh elements of each EntityType. More...

long_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_Group: interface of a standalone group object.

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.

long SMESH::SMESH_Group::AddFrom ( in SMESH_IDSource theSource )

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

void SMESH::SMESH_Group::Clear ( )

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.

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

long SMESH::SMESH_GroupBase::GetID ( in long elem_index )

inherited

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

long_array SMESH::SMESH_IDSource::GetIDs ( )

inherited

Returns a sequence of all element IDs.

long_array SMESH::SMESH_GroupBase::GetListOfID ( )

inherited

Returns a sequence of all element IDs in the group.

SMESH_Mesh SMESH::SMESH_IDSource::GetMesh ( )

inherited

Returns the mesh.

long_array SMESH::SMESH_IDSource::GetMeshInfo ( )

inherited

Returns number of mesh elements of each EntityType.

Returns: array of number of elements per EntityType

string SMESH::SMESH_GroupBase::GetName ( )

inherited

Returns group name.

Referenced by SMESH_GroupBase_i::GetName(), SMESH::SMESH_Mesh::HasDuplicatedGroupNamesMED(), and SMESH_GroupBase_i::SetName().

long_array SMESH::SMESH_IDSource::GetNbElementsByType ( )

inherited

Returns number of mesh elements of each ElementType.

Returns: array of number of elements per ElementType

long_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.

long 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.

ElementType SMESH::SMESH_GroupBase::GetType ( )

inherited

Returns group type (type of elements in the group)

Referenced by SMESH::SMESH_Mesh::HasDuplicatedGroupNamesMED().

array_of_ElementType SMESH::SMESH_IDSource::GetTypes ( )

inherited

Returns types of elements it contains.

It's empty if the SMESH_IDSource contains no IDs

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

inherited

Returns mesh unstructed grid information.

boolean SMESH::SMESH_GroupBase::IsEmpty ( )

inherited

Returns true if the group does not contain any elements.

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.

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.

boolean SMESH::SMESH_GroupBase::IsNodeInfoAvailable ( )

inherited

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.

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

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.

Referenced by SMESH_GroupBase_i::SetName().

long SMESH::SMESH_GroupBase::Size ( )

inherited

Returns the number of elements in the group.

Public Member Functions

Detailed Description

Member Function Documentation