Interface to access other GEOM interfaces. More...

import "GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_Gen:

Public Member Functions
void	Undo (in long theStudyID)
	Undo/Redo Management. More...

void	Redo (in long theStudyID)

SALOMEDS::SObject	AddInStudy (in SALOMEDS::Study theStudy, in GEOM_BaseObject theObject, in string theName, in GEOM_BaseObject theFather)
	Publishing management. More...

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

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

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

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_IFieldOperations	GetIFieldOperations (in long theStudyID) raises (SALOME::SALOME_Exception)

GEOM_IOperations	GetPluginOperations (in long theStudyID, 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 long theStudyID, 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 SALOMEDS::Study theStudy, 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 SALOMEDS::Study theStudy, in string_array theListOfEntries)
	Collects dependencies of the given objects from other ones. More...

void	GetEntriesToReduceStudy (in SALOMEDS::Study theStudy, 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...

Detailed Description

Also contains some methods to access and manage GEOM_Object.

Member Function Documentation

SALOMEDS::SObject GEOM::GEOM_Gen::AddInStudy	(	in SALOMEDS::Study	theStudy,
		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

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

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

theName	name of the folder
theFather	parent object

Returns: SObject represented the created folder.

string_array GEOM::GEOM_Gen::GetAllDumpNames ( )

SALOMEDS::TMPFile GEOM::GEOM_Gen::GetDependencyTree	(	in SALOMEDS::Study	theStudy,
		in string_array	theListOfEntries
	)

Parameters

theStudy	The study in which the object is published
theListOfEntries	List 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.

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

Parameters

theStudyEntry is an entry of the GEOM_Object in the study

void GEOM::GEOM_Gen::GetEntriesToReduceStudy	(	in SALOMEDS::Study	theStudy,
		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

theStudy	The study in which the object was published
theSelectedEntries	List of GEOM object entries in OCAF tree
theParentEntries	List of GEOM object entries on which the given objects depend
theSubEntries	Children entries list of the given objects
theOtherEntries	List 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.

GEOM_I3DPrimOperations GEOM::GEOM_Gen::GetI3DPrimOperations ( 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_IFieldOperations GEOM::GEOM_Gen::GetIFieldOperations ( 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)

GEOM_Object GEOM::GEOM_Gen::GetIORFromString ( in string theIOR )

Parameters

theIOR a 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_BaseObject GEOM::GEOM_Gen::GetObject	(	in long	theStudyID,
		in string	theEntry
	)

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_IOperations GEOM::GEOM_Gen::GetPluginOperations	(	in long	theStudyID,
		in string	theLibName
	)		raises (SALOME::SALOME_Exception)

string GEOM::GEOM_Gen::GetStringFromIOR ( in GEOM_Object theObject )

Parameters

theObject is a GEOM_Object which IOR is requested

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

what	objects being moved
where	parent object where objects are moved to
row	position in the parent object's children list at which objects are moved

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

The moved objects should be first published in the study.

Parameters

theListOfGO	list of GEOM objects to move
theFolder	target folder

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

The moved object should be first published in the study.

Parameters

theObject	GEOM object to move
theFolder	target folder

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

Parameters

theStudy	The study in which the object is published
theObject	The object which named sub-shapes are published

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

void GEOM::GEOM_Gen::RemoveObject ( in GEOM_BaseObject theObject )

Parameters

theObject is 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
	)

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 sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArg	set 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.
theAddPrefix	add 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

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
	)

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 sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArg	set 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.
theAddPrefix	add 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

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
	)

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

Parameters

theStudy	the study, in which theObject is published already, and in which the arguments will be published
theSObject	study object, referencing 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 sub-shapes, corresponding to arguments and their sub-shapes. Value from enumeration GEOM::find_shape_method.
theInheritFirstArg	set 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.
theAddPrefix	add prefix "from_" to names of restored sub-shapes, and prefix "from_subshapes_of_" to names of partially restored sub-shapes.

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

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

idl/GEOM_Gen.idl

Public Member Functions

Detailed Description

Member Function Documentation