Back to index

salome-geom  6.5.0
Public Member Functions
GEOM::GEOM_Gen Interface Reference

Interface to access other GEOM interfaces. More...

import "GEOM_Gen.idl";

List of all members.

Public Member Functions

void Undo (in long theStudyID)
 Undo/Redo Management.
void Redo (in long theStudyID)
SALOMEDS::SObject AddInStudy (in SALOMEDS::Study theStudy, in GEOM_Object theObject, in string theName, in GEOM_Object theFather)
 Publishing management.
ListOfGO 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.
ListOfGO 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.
ListOfGO 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.
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)
 Removes the object from the GEOM component.
GEOM_Object GetObject (in long theStudyID, in string theEntry)
 Returns an object defined by the study and its entry in the GEOM component.
GEOM_Object 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)
GEOM_Object GetIORFromString (in string theIOR)
 Returns a GEOM_Object defined by its IOR.
string GetStringFromIOR (in GEOM_Object theObject)
 Returns a string which contains an IOR of the GEOM_Object.
string GetDumpName (in string theStudyEntry)
 Returns a name with which a GEOM_Object was dumped into python script.
string_array GetAllDumpNames ()
 Returns all names with which a GEOM_Object was dumped into python script to avoid the same names in SMESH script.
ListOfGO PublishNamedShapesInStudy (in SALOMEDS::Study theStudy, in Object theObject)
 Publishes the named sub-shapes of given object in the study.

Detailed Description

Interface to access other GEOM interfaces.

Also contains some methods to access and manage GEOM_Object.

Definition at line 3770 of file GEOM_Gen.idl.


Member Function Documentation

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

Here is the caller graph for this function:

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_Object can has ONLY ONE function. Don't try to apply modification operations on them.
Internal method

Here is the caller graph for this function:

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

string GEOM::GEOM_Gen::GetDumpName ( in string  theStudyEntry)

Returns a name with which a GEOM_Object was dumped into python script.

Parameters:
theStudyEntryis an entry of the GEOM_Object in the study
GEOM_I3DPrimOperations GEOM::GEOM_Gen::GetI3DPrimOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IAdvancedOperations GEOM::GEOM_Gen::GetIAdvancedOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IBasicOperations GEOM::GEOM_Gen::GetIBasicOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IBlocksOperations GEOM::GEOM_Gen::GetIBlocksOperations ( 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_IGroupOperations GEOM::GEOM_Gen::GetIGroupOperations ( 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_ILocalOperations GEOM::GEOM_Gen::GetILocalOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
GEOM_IMeasureOperations GEOM::GEOM_Gen::GetIMeasureOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)

Returns a GEOM_Object defined by its IOR.

Parameters:
theIORa string containg an IOR of the requested GEOM_Object
GEOM_IShapesOperations GEOM::GEOM_Gen::GetIShapesOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
GEOM_ITransformOperations GEOM::GEOM_Gen::GetITransformOperations ( in long  theStudyID) raises (SALOME::SALOME_Exception)
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:
theStudyIDis a SALOMEDS Study ID
theEntryis 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

Returns a string which contains an IOR of the GEOM_Object.

Parameters:
theObjectis a GEOM_Object which IOR is requested
ListOfGO GEOM::GEOM_Gen::PublishNamedShapesInStudy ( in SALOMEDS::Study  theStudy,
in Object  theObject 
)

Publishes the named sub-shapes of given object in the study.

Parameters:
theStudyThe study in which the object is published
theObjectThe object which named sub-shapes are published
void GEOM::GEOM_Gen::Redo ( in long  theStudyID)
void GEOM::GEOM_Gen::RemoveObject ( in GEOM_Object  theObject)

Removes the object from the GEOM component.

Parameters:
theObjectis a GEOM_Object to be removed
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:
theStudythe study, in which theObject is published already, and in which the arguments will be published
theObjectpublished GEOM_Object, arguments of which will be published
theArgslist of GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethodmethod to search sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArgset properties of the first argument for theObject. Do not publish sub-shapes in place of arguments, but only in place of sub-shapes 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.
theAddPrefixadd prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
Returns:
list of published sub-shapes

Here is the caller graph for this function:

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:
theStudythe study, in which theObject is published already, and in which the arguments will be published
theObjectpublished GEOM_Object, arguments of which will be published
theArgslist of GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethodmethod to search sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArgset properties of the first argument for theObject. Do not publish sub-shapes in place of arguments, but only in place of sub-shapes 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.
theAddPrefixadd prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.
Returns:
list of published sub-shapes

Here is the caller graph for this function:

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:
theStudythe study, in which theObject is published already, and in which the arguments will be published
theSObjectstudy object, referencing GEOM_Object, arguments of which will be published
theArgslist of GEOM_Object, operation arguments to be published. If this list is empty, all operation arguments will be published
theFindMethodmethod to search sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArgset properties of the first argument for theObject. Do not publish sub-shapes in place of arguments, but only in place of sub-shapes 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.
theAddPrefixadd prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.

Here is the caller graph for this function:

void GEOM::GEOM_Gen::Undo ( in long  theStudyID)

Undo/Redo Management.


The documentation for this interface was generated from the following file: