Interface of the field. More...

import "GEOM_Gen.idl";

Public Member Functions
GEOM_Object	GetShape ()
	Returns the shape the field lies on. More...

field_data_type	GetDataType ()
	Returns type of field data. More...

short	GetDimension ()
	Returns dimension of the shape the field lies on 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape. More...

string_array	GetComponents ()
	Returns names of components. More...

GEOM_FieldStep	AddStep (in long stepID, in long stamp)
	Removes a component. Component number counts from one. More...

void	RemoveStep (in long stepID)
	Remove a time step from the field. More...

long	CountSteps ()
	Returns number of time steps in the field. More...

ListOfLong	GetSteps ()
	Returns a list of time step IDs in the field. More...

GEOM_FieldStep	GetStep (in long stepID)
	Returns a time step by its ID. More...

long	GetArraySize ()
	Returns a size of data array that is to be passed to GEOM_FieldStep.SetValues( dataArray ). This size depends on the number of sub-shapes of field dimension and the number of components. 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 field.

Member Function Documentation

GEOM_Object GetShape ( )

Returns the shape the field lies on.

field_data_type GetDataType ( )

Returns type of field data.

short GetDimension ( )

Returns dimension of the shape the field lies on 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape.

string_array GetComponents ( )

Returns names of components.

GEOM_FieldStep AddStep	(	in long	stepID,
		in long	stamp
	)

Removes a component. Component number counts from one.

Adds a time step to the field

void RemoveStep ( in long stepID )

Remove a time step from the field.

long CountSteps ( )

Returns number of time steps in the field.

ListOfLong GetSteps ( )

Returns a list of time step IDs in the field.

GEOM_FieldStep GetStep ( in long stepID )

Returns a time step by its ID.

long GetArraySize ( )

Returns a size of data array that is to be passed to GEOM_FieldStep.SetValues( dataArray ). This size depends on the number of sub-shapes of field dimension and the number of components.

void SetName ( in string theName )

inherited

Set name of the object.

Parameters

theName is 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

theParameters is 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.

Public Member Functions

Detailed Description

Member Function Documentation