GEOM.GEOM_Gen Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_Gen:

Public Member Functions
void	Undo (in long theStudyID)
void	Redo (in long theStudyID)
SALOMEDS::SObject	AddInStudy (in SALOMEDS::Study theStudy, in GEOM_Object theObject, in string theName, in GEOM_Object theFather)
ListOfGO	RestoreSubShapesO (in SALOMEDS::Study theStudy, in GEOM_Object theObject, in ListOfGO theArgs, in find_shape_method theFindMethod, in boolean theInheritFirstArg, in boolean theAddPrefix)
ListOfGO	RestoreGivenSubShapesO (in SALOMEDS::Study theStudy, in GEOM_Object theObject, in ListOfGO theArgs, in find_shape_method theFindMethod, in boolean theInheritFirstArg, in boolean theAddPrefix)
ListOfGO	RestoreSubShapesSO (in SALOMEDS::Study theStudy, in SALOMEDS::SObject theSObject, in ListOfGO theArgs, in find_shape_method theFindMethod, in boolean theInheritFirstArg, in boolean theAddPrefix)
GEOM_IBasicOperations	GetIBasicOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_ITransformOperations	GetITransformOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_I3DPrimOperations	GetI3DPrimOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IShapesOperations	GetIShapesOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IBooleanOperations	GetIBooleanOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_ICurvesOperations	GetICurvesOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_ILocalOperations	GetILocalOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IHealingOperations	GetIHealingOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IInsertOperations	GetIInsertOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IMeasureOperations	GetIMeasureOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IBlocksOperations	GetIBlocksOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IGroupOperations	GetIGroupOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IAdvancedOperations	GetIAdvancedOperations (in long theStudyID) raises (SALOME::SALOME_Exception)
void	RemoveObject (in GEOM_Object theObject)
GEOM_Object	GetObject (in long theStudyID, in string theEntry)
GEOM_Object	AddSubShape (in GEOM_Object theMainShape, in ListOfLong theIndices)
GEOM_Object	GetIORFromString (in string theIOR)
string	GetStringFromIOR (in GEOM_Object theObject)
string	GetDumpName (in string theStudyEntry)
string_array	GetAllDumpNames ()
ListOfGO	PublishNamedShapesInStudy (in SALOMEDS::Study theStudy, in Object theObject)

---

Detailed Description

GEOM_Gen: Interface to access other GEOM interfaces. Also contains some methods to access and manage GEOM objects.

---

Member Function Documentation

void GEOM.GEOM_Gen.Undo

(

in long

theStudyID

)

Undo/Redo Management

void GEOM.GEOM_Gen.Redo

(

in long

theStudyID

)

SALOMEDS::SObject GEOM.GEOM_Gen.AddInStudy	(	in SALOMEDS::Study	theStudy,
		in GEOM_Object	theObject,
		in string	theName,
		in GEOM_Object	theFather
	)

Publishing management Adds in theStudy a object theObject under with a name theName, if theFather is not NULL the object is placed under thFather's SObject. Returns a SObject where theObject is placed

ListOfGO GEOM.GEOM_Gen.RestoreSubShapesO	(	in SALOMEDS::Study	theStudy,
		in GEOM_Object	theObject,
		in ListOfGO	theArgs,
		in find_shape_method	theFindMethod,
		in boolean	theInheritFirstArg,
		in boolean	theAddPrefix
	)

Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of geompy.addToStudy (non-default usage)

Parameters:

theStudy	the study, in which theObject is published already, and in which the arguments will be published
theObject	published GEOM object, arguments of which will be published
theArgs	list of GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethod	method to search subshapes, corresponding to arguments and their subshapes. Value from enumeration GEOM.find_shape_method.
theInheritFirstArg	set properties of the first argument for theObject. Do not publish subshapes in place of arguments, but only in place of subshapes of the first argument, because the whole shape corresponds to the first argument. Mainly to be used after transformations, but it also can be usefull after partition with one object shape, and some other operations, where only the first argument has to be considered. If theObject has only one argument shape, this flag is automatically considered as True, not regarding really passed value.
theAddPrefix	add prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored subshapes.

Returns:

list of published sub-shapes

ListOfGO GEOM.GEOM_Gen.RestoreGivenSubShapesO	(	in SALOMEDS::Study	theStudy,
		in GEOM_Object	theObject,
		in ListOfGO	theArgs,
		in find_shape_method	theFindMethod,
		in boolean	theInheritFirstArg,
		in boolean	theAddPrefix
	)

Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from python scripts out of geompy.addToStudy (non-default usage)

Parameters:

theStudy	the study, in which theObject is published already, and in which the arguments will be published
theObject	published GEOM object, arguments of which will be published
theArgs	list of GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethod	method to search subshapes, corresponding to arguments and their subshapes. Value from enumeration GEOM.find_shape_method.
theInheritFirstArg	set properties of the first argument for theObject. Do not publish subshapes in place of arguments, but only in place of subshapes of the first argument, because the whole shape corresponds to the first argument. Mainly to be used after transformations, but it also can be usefull after partition with one object shape, and some other operations, where only the first argument has to be considered. If theObject has only one argument shape, this flag is automatically considered as True, not regarding really passed value.
theAddPrefix	add prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored subshapes.

Returns:

list of published sub-shapes

ListOfGO GEOM.GEOM_Gen.RestoreSubShapesSO	(	in SALOMEDS::Study	theStudy,
		in SALOMEDS::SObject	theSObject,
		in ListOfGO	theArgs,
		in find_shape_method	theFindMethod,
		in boolean	theInheritFirstArg,
		in boolean	theAddPrefix
	)

Publish sub-shapes, standing for arguments and sub-shapes of arguments To be used from GUI and from geompy.addToStudy. Work like the above method, but accepts study object theSObject instead of GEOM_Object.

Parameters:

theSObject

study object, referencing GEOM object, arguments of which will be published

GEOM_IBasicOperations GEOM.GEOM_Gen.GetIBasicOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

Methods to access interfaces for objects creation and transformation

GEOM_ITransformOperations GEOM.GEOM_Gen.GetITransformOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_I3DPrimOperations GEOM.GEOM_Gen.GetI3DPrimOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IShapesOperations GEOM.GEOM_Gen.GetIShapesOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IBooleanOperations GEOM.GEOM_Gen.GetIBooleanOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_ICurvesOperations GEOM.GEOM_Gen.GetICurvesOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_ILocalOperations GEOM.GEOM_Gen.GetILocalOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IHealingOperations GEOM.GEOM_Gen.GetIHealingOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IInsertOperations GEOM.GEOM_Gen.GetIInsertOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IMeasureOperations GEOM.GEOM_Gen.GetIMeasureOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IBlocksOperations GEOM.GEOM_Gen.GetIBlocksOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IGroupOperations GEOM.GEOM_Gen.GetIGroupOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

GEOM_IAdvancedOperations GEOM.GEOM_Gen.GetIAdvancedOperations

(

in long

theStudyID

)

raises (SALOME::SALOME_Exception)

void GEOM.GEOM_Gen.RemoveObject

(

in GEOM_Object

theObject

)

Objects Management

Removes the object from the GEOM component

Parameters:

theObject

is a GEOM object to be removed

GEOM_Object GEOM.GEOM_Gen.GetObject	(	in long	theStudyID,
		in string	theEntry
	)

Returns an object defined by the study and its entry in the GEOM component

Parameters:

theStudyID	is a SALOMEDS Study ID
theEntry	is an entry of the requested GEOM object in the GEOM component

Note:

if the object has not previously been created a NULL GEOM object is returned

GEOM_Object GEOM.GEOM_Gen.AddSubShape	(	in GEOM_Object	theMainShape,
		in ListOfLong	theIndices
	)

Add a sub shape defined by indices in theIndices (contains unique IDs of sub shapes inside theMainShape)

Note:

The sub shape GEOM_Objects can has ONLY ONE function. Don't try to apply modification operations on them.

Internal method

GEOM_Object GEOM.GEOM_Gen.GetIORFromString

(

in string

theIOR

)

GEOM object's IOR Management

Returns a GEOM Object defined by its IOR

Parameters:

theIOR

a string containg an IOR of the requested GEOM object

string GEOM.GEOM_Gen.GetStringFromIOR

(

in GEOM_Object

theObject

)

Returns a string which contains an IOR of the GEOM object

Parameters:

theObject

is a GEOM object which IOR is requested

string GEOM.GEOM_Gen.GetDumpName

(

in string

theStudyEntry

)

Returns a name with which a GEOM object was dumped into python script

Parameters:

theStudyEntry

is an entry of the GEOM object in the study

string_array GEOM.GEOM_Gen.GetAllDumpNames

(

)

Returns all names with which a GEOM objects was dumped into python script to avoid the same names in SMESH script

ListOfGO GEOM.GEOM_Gen.PublishNamedShapesInStudy	(	in SALOMEDS::Study	theStudy,
		in Object	theObject
	)

Publishes the named subshapes of given object in the study.

Parameters:

theStudy	The study in which the object is published
theObject	The object which named subshapes are published