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

void	AddObject (in GEOM_Object theGroup, in long theSubShapeId)
	Adds a sub-object with ID theSubShapeId to the group. More...

void	RemoveObject (in GEOM_Object theGroup, in long theSubShapeId)
	Removes a sub-object with ID theSubShapeId from the group. More...

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

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

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

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

GEOM_Object	UnionGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2)
	Union of two groups. New group is created. It will contain all entities which are present in groups theGroup1 and theGroup2. More...

GEOM_Object	IntersectGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2)
	Intersection of two groups. New group is created. It will contain only those entities which are present in both groups theGroup1 and theGroup2. More...

GEOM_Object	CutGroups (in GEOM_Object theGroup1, in GEOM_Object theGroup2)
	Cut of two groups. New group is created. It will contain entities which are present in group theGroup1 but are not present in group theGroup2. More...

GEOM_Object	UnionListOfGroups (in ListOfGO theGList)
	Union of list of groups. New group is created. It will contain all entities that are present in groups listed in theGList. More...

GEOM_Object	IntersectListOfGroups (in ListOfGO theGList)
	Intersection of list of groups. New group is created. It will contain only entities which are simultaneously present in the groups listed in theGList. More...

GEOM_Object	CutListOfGroups (in ListOfGO theGList1, in ListOfGO theGList2)
	Cut of lists of groups. New group is created. It will contain only entities which are present in groups listed in theGList1 but are not present in groups from theGList2. More...

long	GetType (in GEOM_Object theGroup)
	Returns a type of sub-objects stored in the group. More...

GEOM_Object	GetMainShape (in GEOM_Object theGroup)
	Returns a main shape associated with the group. More...

ListOfLong	GetObjects (in GEOM_Object theGroup)
	Returns a list of sub-objects ID stored in the group. More...

boolean	IsDone ()
	To know, if the operation was successfully performed. More...

void	SetErrorCode (in string theErrorID)
	Set the operation error code. More...

string	GetErrorCode ()
	Get the operation error code. More...

long	GetStudyID ()
	Get ID of study, where the operation is defined. More...

void	StartOperation ()
	Opens a new transaction. More...

void	FinishOperation ()
	Closes the previously opened trasaction. More...

void	AbortOperation ()
	Aborts the previously opened transaction. More...

Detailed Description

Interface for groups creation.

Member Function Documentation

GEOM_Object 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 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 GEOM_IShapesOperations.GetSubShapeIndex() to get an ID by the sub-shape

void 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 GEOM_IShapesOperations.GetSubShapeIndex() to get an ID by the sub-shape

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.

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

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.

Parameters

theGroup	is a GEOM group to which the new sub-shapes are added.
theSubShapes	is a list of IDs of sub-shapes to be added.

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.

Parameters

theGroup	is a GEOM group from which the sub-shapes are removed.
theSubShapes	is a list of IDs of sub-shapes to be removed.

GEOM_Object UnionGroups	(	in GEOM_Object	theGroup1,
		in GEOM_Object	theGroup2
	)

Union of two groups. New group is created. It will contain all entities which are present in groups theGroup1 and theGroup2.

Parameters

theGroup1,theGroup2 are the initial GEOM groups to create the united group from.

Returns: a newly created GEOM group.

GEOM_Object IntersectGroups	(	in GEOM_Object	theGroup1,
		in GEOM_Object	theGroup2
	)

Intersection of two groups. New group is created. It will contain only those entities which are present in both groups theGroup1 and theGroup2.

Parameters

theGroup1,theGroup2 are the initial GEOM groups to get common part of.

Returns: a newly created GEOM group.

GEOM_Object CutGroups	(	in GEOM_Object	theGroup1,
		in GEOM_Object	theGroup2
	)

Cut of two groups. New group is created. It will contain entities which are present in group theGroup1 but are not present in group theGroup2.

Parameters

theGroup1	is a GEOM group to include elements of.
theGroup2	is a GEOM group to exclude elements of.

Returns: a newly created GEOM group.

GEOM_Object UnionListOfGroups ( in ListOfGO theGList )

Union of list of groups. New group is created. It will contain all entities that are present in groups listed in theGList.

Parameters

theGList is a list of GEOM groups to create the united group from.

Returns: a newly created GEOM group.

GEOM_Object IntersectListOfGroups ( in ListOfGO theGList )

Intersection of list of groups. New group is created. It will contain only entities which are simultaneously present in the groups listed in theGList.

Parameters

theGList is a list of GEOM groups to get common part of.

Returns: a newly created GEOM group.

GEOM_Object CutListOfGroups	(	in ListOfGO	theGList1,
		in ListOfGO	theGList2
	)

Cut of lists of groups. New group is created. It will contain only entities which are present in groups listed in theGList1 but are not present in groups from theGList2.

Parameters

theGList1	is a list of GEOM groups to include elements of.
theGList2	is a list of GEOM groups to exclude elements of.

Returns: a newly created GEOM group.

long 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 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 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 IsDone ( )

inherited

To know, if the operation was successfully performed.

void 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 GetErrorCode ( )

inherited

Get the operation error code.

long GetStudyID ( )

inherited

Get ID of study, where the operation is defined.

void StartOperation ( )

inherited

Opens a new transaction.

void FinishOperation ( )

inherited

Closes the previously opened trasaction.

void AbortOperation ( )

inherited

Aborts the previously opened transaction.

Public Member Functions

Detailed Description

Member Function Documentation