GEOM.GEOM_IGroupOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_IGroupOperations:

Inheritance graph

Public Member Functions

GEOM_Object CreateGroup (in GEOM_Object theMainShape, in long theShapeType)
void AddObject (in GEOM_Object theGroup, in long theSubShapeId)
void RemoveObject (in GEOM_Object theGroup, in long theSubShapeId)
void UnionList (in GEOM_Object theGroup, in ListOfGO theSubShapes)
void DifferenceList (in GEOM_Object theGroup, in ListOfGO theSubShapes)
long GetType (in GEOM_Object theGroup)
GEOM_Object GetMainShape (in GEOM_Object theGroup)
ListOfLong GetObjects (in GEOM_Object theGroup)
boolean IsDone ()
void SetErrorCode (in string theErrorID)
string GetErrorCode ()
long GetStudyID ()
void StartOperation ()
void FinishOperation ()
void AbortOperation ()

Detailed Description

GEOM_IGroupOperations: 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:
theMainShape is a GEOM object on which the group is selected
theShapeType defines 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:
theGroup is a GEOM group to which the new sub shape is added
theSubShapeId is a sub shape ID in the main object.
Note:
Use method ILocalOperations.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:
theGroup is a GEOM group from which the sub shape is removed.
theSubShapeId is a sub shape ID in the main object.
Note:
Use method ILocalOperations.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:
theGroup is a GEOM group to which the new sub shapes are added.
theSubShapes is 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:
theGroup is a GEOM group from which the sub-shapes are removed.
theSubShapes is a list 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:
theGroup is 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:
theGroup is 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:
theGroup is 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:
theErrorID is 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


Generated on Wed Feb 8 00:24:06 2006 for SALOME - GEOM - v.2.2.8 by doxygen 1.3.7