GEOM_BaseObject Interface Reference

A common root of objects in GEOM module. More...

import "GEOM_Gen.idl";

Public Member Functions
void	SetName (in string theName)
	Set name of the object. More...
string	GetName ()
	Get name of the object associated with this object. More...
string	GetEntry ()
	Get internal (unique) entry of the object in the GEOM component's data tree. More...
long	GetStudyID ()
	Get ID of study, where the object is created. More...
long	GetType ()
	Get internal type of operation created this object (POINT, BOX, CYLINDER, EXTRUSION...). More...
long	GetTick ()
	Get value of a modification counter of the object. More...
void	SetStudyEntry (in string theEntry)
	Set a Study entry where this object was published. More...
string	GetStudyEntry ()
	Get a Study entry where this object was published. More...
ListOfGBO	GetDependency ()
	Get a list of all GEOM_Object on which were the arguments when this object was constructed and modified. More...
ListOfGBO	GetLastDependency ()
	Get a list of GEOM_Object on which the last function that created or modified the object depends. More...
boolean	IsShape ()
boolean	IsSame (in GEOM_BaseObject other)
void	SetParameters (in string theParameters)
string	GetParameters ()
	Return list of notebook variables used for object creation separated by ":" symbol. More...
CreationInformationSeq	GetCreationInformation ()
	Return name of operation and values of parameters used for object creation. More...

Detailed Description

A common root of objects in GEOM module.

Member Function Documentation

void SetName

(

in string

theName

)

Set name of the object.

Parameters

theName

is a name which will be associated with this object.

string GetName

(

)

Get name of the object associated with this object.

string GetEntry

(

)

Get internal (unique) entry of the object in the GEOM component's data tree.

Note

This is not an entry of the data object in SALOME study. This is internal function of GEOM component, though it can be used outside it for appropriate reason (e.g. for unique identification of geometry object).

long GetStudyID

(

)

Get ID of study, where the object is created.

long GetType

(

)

Get internal type of operation created this object (POINT, BOX, CYLINDER, EXTRUSION...).

Note

To get topological information on the object, use WhatIs() or KindOfShape() operation.

long GetTick

(

)

Get value of a modification counter of the object.

void SetStudyEntry

(

in string

theEntry

)

Set a Study entry where this object was published.

string GetStudyEntry

(

)

Get a Study entry where this object was published.

ListOfGBO GetDependency

(

)

Get a list of all GEOM_Object on which were the arguments when this object was constructed and modified.

Note

This method is supposed to be used by GUI only.

ListOfGBO GetLastDependency

(

)

Get a list of GEOM_Object on which the last function that created or modified the object depends.

Note

This method is supposed to be used by GUI only.

boolean IsShape

(

)

boolean IsSame

(

in GEOM_BaseObject

other

)

void SetParameters

(

in string

theParameters

)

Set list of parameters

Parameters

theParameters

is a string containing the notebook variables separated by ":" symbol, used for object creation

string GetParameters

(

)

Return list of notebook variables used for object creation separated by ":" symbol.

CreationInformationSeq GetCreationInformation

(

)

Return name of operation and values of parameters used for object creation.