Version: 6.5.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions
GEOM::GEOM_IGroupOperations Interface Reference

Interface for groups creation. More...

import "GEOM_Gen.idl";

Public Member Functions

GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType)
 Creates a new group which will store sub-shapes of theMainShape.
void AddObject (in GEOM_Object theGroup, in long theSubShapeId)
 Adds a sub-object with ID theSubShapeId to the group.
void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId)
 Removes a sub-object with ID theSubShapeId from the group.
void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes)
 Adds to the group all the given shapes. No errors, if some shapes are alredy included.
void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes)
 Removes from the group all the given shapes. No errors, if some shapes are not included.
void UnionIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes)
 Adds to the group all the given shapes. No errors, if some shapes are alredy included.
void DifferenceIDs (in GEOM_Object theGroup, in ListOfLong theSubShapes)
 Removes from the group all the given shapes. No errors, if some shapes are not included.
long GetType (in GEOM_Object theGroup)
 Returns a type of sub-objects stored in the group.
GEOM_Object GetMainShape (in GEOM_Object theGroup)
 Returns a main shape associated with the group.
ListOfLong GetObjects (in GEOM_Object theGroup)
 Returns a list of sub-objects ID stored in the group.
boolean IsDone ()
 To know, if the operation was successfully performed.
void SetErrorCode (in string theErrorID)
 Set the operation error code.
string GetErrorCode ()
 Get the operation error code.
long GetStudyID ()
 Get ID of study, where the operation is defined.
void StartOperation ()
 Opens a new transaction.
void FinishOperation ()
 Closes the previously opened trasaction.
void AbortOperation ()
 Aborts the previously opened transaction.

Detailed Description

Interface for groups creation.

Member Function Documentation

GEOM_Object GEOM::GEOM_IGroupOperations::CreateGroup ( in GEOM_Object  theMainShape,
in long  theShapeType 
)

Creates a new group which will store sub-shapes of theMainShape.

Parameters
theMainShapeis a GEOM_Object on which the group is selected
theShapeTypedefines a shape type of the group
Returns
a newly created GEOM group
void GEOM::GEOM_IGroupOperations::AddObject ( in GEOM_Object  theGroup,
in long  theSubShapeId 
)

Adds a sub-object with ID theSubShapeId to the group.

Parameters
theGroupis a GEOM group to which the new sub-shape is added
theSubShapeIdis a sub-shape ID in the main object.
Note
Use method GEOM_IShapesOperations.GetSubShapeIndex() to get an ID by the sub-shape
void GEOM::GEOM_IGroupOperations::RemoveObject ( in GEOM_Object  theGroup,
in long  theSubShapeId 
)

Removes a sub-object with ID theSubShapeId from the group.

Parameters
theGroupis a GEOM group from which the sub-shape is removed.
theSubShapeIdis a sub-shape ID in the main object.
Note
Use method GEOM_IShapesOperations.GetSubShapeIndex() to get an ID by the sub-shape
void GEOM::GEOM_IGroupOperations::UnionList ( in GEOM_Object  theGroup,
in ListOfGO  theSubShapes 
)

Adds to the group all the given shapes. No errors, if some shapes are alredy included.

Parameters
theGroupis a GEOM group to which the new sub-shapes are added.
theSubShapesis a list of sub-shapes to be added.
void GEOM::GEOM_IGroupOperations::DifferenceList ( in GEOM_Object  theGroup,
in ListOfGO  theSubShapes 
)

Removes from the group all the given shapes. No errors, if some shapes are not included.

Parameters
theGroupis a GEOM group from which the sub-shapes are removed.
theSubShapesis a list of sub-shapes to be removed.
void GEOM::GEOM_IGroupOperations::UnionIDs ( in GEOM_Object  theGroup,
in ListOfLong  theSubShapes 
)

Adds to the group all the given shapes. No errors, if some shapes are alredy included.

Parameters
theGroupis a GEOM group to which the new sub-shapes are added.
theSubShapesis a list of IDs of sub-shapes to be added.
void GEOM::GEOM_IGroupOperations::DifferenceIDs ( in GEOM_Object  theGroup,
in ListOfLong  theSubShapes 
)

Removes from the group all the given shapes. No errors, if some shapes are not included.

Parameters
theGroupis a GEOM group from which the sub-shapes are removed.
theSubShapesis a list of IDs of sub-shapes to be removed.
long GEOM::GEOM_IGroupOperations::GetType ( in GEOM_Object  theGroup)

Returns a type of sub-objects stored in the group.

Parameters
theGroupis a GEOM group which type is returned.
GEOM_Object GEOM::GEOM_IGroupOperations::GetMainShape ( in GEOM_Object  theGroup)

Returns a main shape associated with the group.

Parameters
theGroupis a GEOM group for which a main shape object is requested
Returns
a GEOM_Object which is a main shape for theGroup
ListOfLong GEOM::GEOM_IGroupOperations::GetObjects ( in GEOM_Object  theGroup)

Returns a list of sub-objects ID stored in the group.

Parameters
theGroupis a GEOM group for which a list of IDs is requested
boolean GEOM::GEOM_IOperations::IsDone ( )
inherited

To know, if the operation was successfully performed.

void GEOM::GEOM_IOperations::SetErrorCode ( in string  theErrorID)
inherited

Set the operation error code.

Parameters
theErrorIDis a string describing the error occured
Note
This method is supposed to be used only by interfaces inheriting from IOperations.
string GEOM::GEOM_IOperations::GetErrorCode ( )
inherited

Get the operation error code.

long GEOM::GEOM_IOperations::GetStudyID ( )
inherited

Get ID of study, where the operation is defined.

void GEOM::GEOM_IOperations::StartOperation ( )
inherited

Opens a new transaction.

void GEOM::GEOM_IOperations::FinishOperation ( )
inherited

Closes the previously opened trasaction.

void GEOM::GEOM_IOperations::AbortOperation ( )
inherited

Aborts the previously opened transaction.

Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS