Version: 9.12.0
GEOM::GEOM_Gen Interface Reference

Interface to access other GEOM interfaces. More...

import"GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_Gen:
Inheritance graph

Public Member Functions

void Undo ()
 Undo/Redo Management. More...
 
void Redo ()
 
SALOMEDS::SObject AddInStudy (in GEOM_BaseObject theObject, in string theName, in GEOM_BaseObject theFather)
 Publishing management. More...
 
ListOfGO RestoreSubShapesO (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. More...
 
ListOfGO RestoreGivenSubShapesO (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. More...
 
ListOfGO RestoreSubShapesSO (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. More...
 
GEOM_IBasicOperations GetIBasicOperations () raises (SALOME::SALOME_Exception)
 
GEOM_ITransformOperations GetITransformOperations () raises (SALOME::SALOME_Exception)
 
GEOM_I3DPrimOperations GetI3DPrimOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IShapesOperations GetIShapesOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IBooleanOperations GetIBooleanOperations () raises (SALOME::SALOME_Exception)
 
GEOM_ICurvesOperations GetICurvesOperations () raises (SALOME::SALOME_Exception)
 
GEOM_ILocalOperations GetILocalOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IHealingOperations GetIHealingOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IInsertOperations GetIInsertOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IMeasureOperations GetIMeasureOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IBlocksOperations GetIBlocksOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IGroupOperations GetIGroupOperations () raises (SALOME::SALOME_Exception)
 
GEOM_IFieldOperations GetIFieldOperations () raises (SALOME::SALOME_Exception)
 
GEOM_ITestOperations GetITestOperations () raises (SALOME::SALOME_Exception)
 
GEOM_ICanonicalRecognition GetICanonicalRecognition () raises (SALOME::SALOME_Exception)
 
GEOM_IOperations GetPluginOperations (in string theLibName) raises (SALOME::SALOME_Exception)
 
void RemoveObject (in GEOM_BaseObject theObject)
 Removes the object from the GEOM component. More...
 
GEOM_BaseObject GetObject (in string theEntry)
 Returns an object defined by the study and its entry in the GEOM component. More...
 
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) More...
 
GEOM_Object GetIORFromString (in string theIOR)
 Returns a GEOM_Object defined by its IOR. More...
 
string GetStringFromIOR (in GEOM_Object theObject)
 Returns a string which contains an IOR of the GEOM_Object. More...
 
string GetDumpName (in string theStudyEntry)
 Returns a name with which a GEOM_Object was dumped into python script. More...
 
string_array GetAllDumpNames ()
 Returns all names with which a GEOM_Object was dumped into python script to avoid the same names in SMESH script. More...
 
ListOfGO PublishNamedShapesInStudy (in Object theObject)
 Publishes the named sub-shapes of given object in the study. More...
 
SALOMEDS::SObject CreateFolder (in string theName, in SALOMEDS::SObject theFather)
 Creates a new folder. More...
 
void MoveToFolder (in GEOM_Object theObject, in SALOMEDS::SObject theFolder)
 Moves object to the specified folder. More...
 
void MoveListToFolder (in ListOfGO theListOfGO, in SALOMEDS::SObject theFolder)
 Moves list of objects to the specified folder. More...
 
void Move (in object_list what, in SALOMEDS::SObject where, in long row)
 Moves objects to the specified position. More...
 
SALOMEDS::TMPFile GetDependencyTree (in string_array theListOfEntries)
 Collects dependencies of the given objects from other ones. More...
 
void GetEntriesToReduceStudy (inout string_array theSelectedEntries, inout string_array theParentEntries, inout string_array theSubEntries, inout string_array theOtherEntries)
 Fills 3 lists that is used to reduce study of redundant objects: More...
 
void BreakLink (in string theEntry)
 

Detailed Description

Also contains some methods to access and manage GEOM_Object.

Member Function Documentation

◆ AddInStudy()

SALOMEDS::SObject GEOM::GEOM_Gen::AddInStudy ( in GEOM_BaseObject  theObject,
in string  theName,
in GEOM_BaseObject  theFather 
)

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

◆ AddSubShape()

GEOM_Object GEOM::GEOM_Gen::AddSubShape ( in GEOM_Object  theMainShape,
in ListOfLong  theIndices 
)
Note
The sub-shape GEOM_Object can has ONLY ONE function. Don't try to apply modification operations on them.
Internal method

◆ BreakLink()

void GEOM::GEOM_Gen::BreakLink ( in string  theEntry)

◆ CreateFolder()

SALOMEDS::SObject GEOM::GEOM_Gen::CreateFolder ( in string  theName,
in SALOMEDS::SObject  theFather 
)

Creates a new container (folder) for any GEOM objects. Folder will have name theName. If theFather is not NULL, the folder is placed under theFather object. Otherwise, the folder takes place under root 'Geometry' object.

Parameters
theNamename of the folder
theFatherparent object
Returns
SObject represented the created folder.

◆ GetAllDumpNames()

string_array GEOM::GEOM_Gen::GetAllDumpNames ( )

◆ GetDependencyTree()

SALOMEDS::TMPFile GEOM::GEOM_Gen::GetDependencyTree ( in string_array  theListOfEntries)
Parameters
theListOfEntriesList of GEOM object entries in OCAF tree (not in study)
Returns
Struct of dependent entries and its links as a byte array
Note
This method is supposed to be used by GUI only.

◆ GetDumpName()

string GEOM::GEOM_Gen::GetDumpName ( in string  theStudyEntry)
Parameters
theStudyEntryis an entry of the GEOM_Object in the study

◆ GetEntriesToReduceStudy()

void GEOM::GEOM_Gen::GetEntriesToReduceStudy ( inout string_array  theSelectedEntries,
inout string_array  theParentEntries,
inout string_array  theSubEntries,
inout string_array  theOtherEntries 
)
  • dependencies of the given objects from other ones;
  • children of the given objects;
  • all other objects in study.
    Parameters
    theSelectedEntriesList of GEOM object entries in OCAF tree
    theParentEntriesList of GEOM object entries on which the given objects depend
    theSubEntriesChildren entries list of the given objects
    theOtherEntriesList of GEOM object entries which are in the study, but not in parents and children lists
    Note
    This method is supposed to be used by GUI only.

◆ GetI3DPrimOperations()

GEOM_I3DPrimOperations GEOM::GEOM_Gen::GetI3DPrimOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIBasicOperations()

GEOM_IBasicOperations GEOM::GEOM_Gen::GetIBasicOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIBlocksOperations()

GEOM_IBlocksOperations GEOM::GEOM_Gen::GetIBlocksOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIBooleanOperations()

GEOM_IBooleanOperations GEOM::GEOM_Gen::GetIBooleanOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetICanonicalRecognition()

GEOM_ICanonicalRecognition GEOM::GEOM_Gen::GetICanonicalRecognition ( )
raises (SALOME::SALOME_Exception
)

◆ GetICurvesOperations()

GEOM_ICurvesOperations GEOM::GEOM_Gen::GetICurvesOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIFieldOperations()

GEOM_IFieldOperations GEOM::GEOM_Gen::GetIFieldOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIGroupOperations()

GEOM_IGroupOperations GEOM::GEOM_Gen::GetIGroupOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIHealingOperations()

GEOM_IHealingOperations GEOM::GEOM_Gen::GetIHealingOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIInsertOperations()

GEOM_IInsertOperations GEOM::GEOM_Gen::GetIInsertOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetILocalOperations()

GEOM_ILocalOperations GEOM::GEOM_Gen::GetILocalOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIMeasureOperations()

GEOM_IMeasureOperations GEOM::GEOM_Gen::GetIMeasureOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetIORFromString()

GEOM_Object GEOM::GEOM_Gen::GetIORFromString ( in string  theIOR)
Parameters
theIORa string containing an IOR of the requested GEOM_Object

◆ GetIShapesOperations()

GEOM_IShapesOperations GEOM::GEOM_Gen::GetIShapesOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetITestOperations()

GEOM_ITestOperations GEOM::GEOM_Gen::GetITestOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetITransformOperations()

GEOM_ITransformOperations GEOM::GEOM_Gen::GetITransformOperations ( )
raises (SALOME::SALOME_Exception
)

◆ GetObject()

GEOM_BaseObject GEOM::GEOM_Gen::GetObject ( in string  theEntry)
Parameters
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

◆ GetPluginOperations()

GEOM_IOperations GEOM::GEOM_Gen::GetPluginOperations ( in string  theLibName)
raises (SALOME::SALOME_Exception
)

◆ GetStringFromIOR()

string GEOM::GEOM_Gen::GetStringFromIOR ( in GEOM_Object  theObject)
Parameters
theObjectis a GEOM_Object which IOR is requested

◆ Move()

void GEOM::GEOM_Gen::Move ( in object_list  what,
in SALOMEDS::SObject  where,
in long  row 
)

This function is used in the drag-n-drop functionality.

Parameters
whatobjects being moved
whereparent object where objects are moved to
rowposition in the parent object's children list at which objects are moved

◆ MoveListToFolder()

void GEOM::GEOM_Gen::MoveListToFolder ( in ListOfGO  theListOfGO,
in SALOMEDS::SObject  theFolder 
)

The moved objects should be first published in the study.

Parameters
theListOfGOlist of GEOM objects to move
theFoldertarget folder

◆ MoveToFolder()

void GEOM::GEOM_Gen::MoveToFolder ( in GEOM_Object  theObject,
in SALOMEDS::SObject  theFolder 
)

The moved object should be first published in the study.

Parameters
theObjectGEOM object to move
theFoldertarget folder

◆ PublishNamedShapesInStudy()

ListOfGO GEOM::GEOM_Gen::PublishNamedShapesInStudy ( in Object  theObject)
Parameters
theObjectThe object which named sub-shapes are published

◆ Redo()

void GEOM::GEOM_Gen::Redo ( )

◆ RemoveObject()

void GEOM::GEOM_Gen::RemoveObject ( in GEOM_BaseObject  theObject)
Parameters
theObjectis a GEOM_Object to be removed

◆ RestoreGivenSubShapesO()

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

To be used from python scripts out of geompy.addToStudy (non-default usage)

Parameters
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 useful 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

◆ RestoreSubShapesO()

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

To be used from python scripts out of geompy.addToStudy (non-default usage)

Parameters
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 useful 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

◆ RestoreSubShapesSO()

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

To be used from GUI and from geompy.addToStudy. Work like the above method, but accepts study object theSObject instead of GEOM_Object.

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

◆ Undo()

void GEOM::GEOM_Gen::Undo ( )

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