GEOM_IFieldOperations Interface Reference

Interface for field operation. More...

import "GEOM_Gen.idl";

Public Member Functions
GEOM_Field	CreateField (in GEOM_Object shape, in string name, in field_data_type type, in short dimension, in string_array componentNames)
	Creates a field. More...
long	CountFields (in GEOM_Object shape)
	Returns number of fields on a shape. More...
ListOfFields	GetFields (in GEOM_Object shape)
	Returns all fields on a shape. More...
GEOM_Field	GetField (in GEOM_Object shape, in string name)
	Returns a field on a shape by its name. More...
long	GetNbSubShapes (in GEOM_Object shape, in short fieldDim)
	Returns number of sub-shapes of given dimension. More...
boolean	IsDone ()
	To know, if the operation was successfully performed. More...
void	SetErrorCode (in string theErrorID)
	Set the operation error code. More...
string	GetErrorCode ()
	Get the operation error code. More...
long	GetStudyID ()
	Get ID of study, where the operation is defined. More...
void	StartOperation ()
	Opens a new transaction. More...
void	FinishOperation ()
	Closes the previously opened trasaction. More...
void	AbortOperation ()
	Aborts the previously opened transaction. More...

Detailed Description

Interface for field operation.

Member Function Documentation

GEOM_Field CreateField	(	in GEOM_Object	shape,
		in string	name,
		in field_data_type	type,
		in short	dimension,
		in string_array	componentNames
	)

Creates a field.

long CountFields

(

in GEOM_Object

shape

)

Returns number of fields on a shape.

ListOfFields GetFields

(

in GEOM_Object

shape

)

Returns all fields on a shape.

GEOM_Field GetField	(	in GEOM_Object	shape,
		in string	name
	)

Returns a field on a shape by its name.

long GetNbSubShapes	(	in GEOM_Object	shape,
		in short	fieldDim
	)

Returns number of sub-shapes of given dimension.

boolean IsDone ( )

inherited

To know, if the operation was successfully performed.

void SetErrorCode ( in string  theErrorID )

inherited

Set the operation error code.

Parameters

theErrorID

is a string describing the error occured

Note

This method is supposed to be used only by interfaces inheriting from IOperations.

string GetErrorCode ( )

inherited

Get the operation error code.

long GetStudyID ( )

inherited

Get ID of study, where the operation is defined.

void StartOperation ( )

inherited

Opens a new transaction.

void FinishOperation ( )

inherited

Closes the previously opened trasaction.

void AbortOperation ( )

inherited

Aborts the previously opened transaction.