Version: 8.3.0
Home
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
GEOM_BoolFieldStep Interface Reference

Interface of the boolean field time step. More...

import "GEOM_Gen.idl";

Public Member Functions

boolean SetValues (in short_array boolValues)
 Changes values of the field step. Returns false if number of values is wrong. More...
 
short_array GetValues ()
 Returns values of the field step. More...
 
void SetStamp (in long stamp)
 Changes the time of the field step. More...
 
long GetStamp ()
 Returns the time of the field step. More...
 
long GetID ()
 Returns the number of the field step. More...
 
GEOM_Field GetField ()
 Returns the field the step belongs to. More...
 
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

Interface of the boolean field time step.

Member Function Documentation

boolean SetValues ( in short_array  boolValues)

Changes values of the field step. Returns false if number of values is wrong.

short_array GetValues ( )

Returns values of the field step.

void SetStamp ( in long  stamp)
inherited

Changes the time of the field step.

long GetStamp ( )
inherited

Returns the time of the field step.

long GetID ( )
inherited

Returns the number of the field step.

GEOM_Field GetField ( )
inherited

Returns the field the step belongs to.

void SetName ( in string  theName)
inherited

Set name of the object.

Parameters
theNameis a name which will be associated with this object.
string GetName ( )
inherited

Get name of the object associated with this object.

string GetEntry ( )
inherited

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 ( )
inherited

Get ID of study, where the object is created.

long GetType ( )
inherited

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 ( )
inherited

Get value of a modification counter of the object.

void SetStudyEntry ( in string  theEntry)
inherited

Set a Study entry where this object was published.

string GetStudyEntry ( )
inherited

Get a Study entry where this object was published.

ListOfGBO GetDependency ( )
inherited

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 ( )
inherited

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 ( )
inherited
boolean IsSame ( in GEOM_BaseObject  other)
inherited
void SetParameters ( in string  theParameters)
inherited

Set list of parameters

Parameters
theParametersis a string containing the notebook variables separated by ":" symbol, used for object creation
string GetParameters ( )
inherited

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

CreationInformationSeq GetCreationInformation ( )
inherited

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