SALOME_MED.FIELD Interface Reference

import "MED.idl";

Inheritance diagram for SALOME_MED.FIELD:

Public Member Functions
string	getName () raises (SALOME::SALOME_Exception)
void	setName (in string theName) raises (SALOME::SALOME_Exception)
string	getDescription () raises (SALOME::SALOME_Exception)
SUPPORT	getSupport () raises (SALOME::SALOME_Exception)
long	getNumberOfComponents () raises (SALOME::SALOME_Exception)
SALOME_TYPES::ListOfString	getComponentsNames () raises (SALOME::SALOME_Exception)
string	getComponentName (in long i) raises (SALOME::SALOME_Exception)
SALOME_TYPES::ListOfString	getComponentsUnits () raises (SALOME::SALOME_Exception)
string	getComponentUnit (in long i) raises (SALOME::SALOME_Exception)
SALOME_TYPES::ListOfString	getComponentsDescriptions () raises (SALOME::SALOME_Exception)
string	getComponentDescription (in long i) raises (SALOME::SALOME_Exception)
long	getIterationNumber () raises (SALOME::SALOME_Exception)
double	getTime () raises (SALOME::SALOME_Exception)
long	getOrderNumber () raises (SALOME::SALOME_Exception)
boolean	getGaussPresence ()
long	addDriver (in medDriverTypes driverType, in string fileName, in string fieldName) raises (SALOME::SALOME_Exception)
void	rmDriver (in long i) raises (SALOME::SALOME_Exception)
void	read (in long i) raises (SALOME::SALOME_Exception)
void	write (in long i, in string driverFieldName) raises (SALOME::SALOME_Exception)
void	addInStudy (in SALOMEDS::Study myStudy, in FIELD myIor) raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection)
void	addInStudyToComponent (in SALOMEDS::SComponent myComponent, in FIELD myIor) raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection)
long	getCorbaIndex () raises (SALOME::SALOME_Exception)

---

Member Function Documentation

string SALOME_MED.FIELD.getName

(

)

raises (SALOME::SALOME_Exception)

Returns the field name.

void SALOME_MED.FIELD.setName

(

in string

theName

)

raises (SALOME::SALOME_Exception)

Changes the field name.

Parameters:

theName

The new name for this field.

string SALOME_MED.FIELD.getDescription

(

)

raises (SALOME::SALOME_Exception)

Returns the field description.

SUPPORT SALOME_MED.FIELD.getSupport

(

)

raises (SALOME::SALOME_Exception)

Returns a reference to the support on which the field is defined.

long SALOME_MED.FIELD.getNumberOfComponents

(

)

raises (SALOME::SALOME_Exception)

Returns the number of field's components.

SALOME_TYPES::ListOfString SALOME_MED.FIELD.getComponentsNames

(

)

raises (SALOME::SALOME_Exception)

Returns an array containing components names.

string SALOME_MED.FIELD.getComponentName

(

in long

i

)

raises (SALOME::SALOME_Exception)

Returns the name of i-th component.

Note:

• i is bounded by 1 and NumberOfComponents.
• Name is mandatory for each field's component.

SALOME_TYPES::ListOfString SALOME_MED.FIELD.getComponentsUnits

(

)

raises (SALOME::SALOME_Exception)

Returns an array containing components units.

string SALOME_MED.FIELD.getComponentUnit

(

in long

i

)

raises (SALOME::SALOME_Exception)

Returns the unit of i-th component.

Note:

i is bounded by 1 and NumberOfComponents.

SALOME_TYPES::ListOfString SALOME_MED.FIELD.getComponentsDescriptions

(

)

raises (SALOME::SALOME_Exception)

Returns an array containing components descriptions.

string SALOME_MED.FIELD.getComponentDescription

(

in long

i

)

raises (SALOME::SALOME_Exception)

Returns the description of i-th component.

Note:

• i is bounded by 1 and NumberOfComponents.
• Name is mandatory for each field's component.

long SALOME_MED.FIELD.getIterationNumber

(

)

raises (SALOME::SALOME_Exception)

Returns the iteration number.

double SALOME_MED.FIELD.getTime

(

)

raises (SALOME::SALOME_Exception)

Returns time for this iteration.

long SALOME_MED.FIELD.getOrderNumber

(

)

raises (SALOME::SALOME_Exception)

Returns order number use for internal step in this iteration.

boolean SALOME_MED.FIELD.getGaussPresence

(

)

Returns if gauss points are present.

long SALOME_MED.FIELD.addDriver	(	in medDriverTypes	driverType,
		in string	fileName,
		in string	fieldName
	)			raises (SALOME::SALOME_Exception)

void SALOME_MED.FIELD.rmDriver

(

in long

i

)

raises (SALOME::SALOME_Exception)

Removes a driver

void SALOME_MED.FIELD.read

(

in long

i

)

raises (SALOME::SALOME_Exception)

void SALOME_MED.FIELD.write	(	in long	i,
		in string	driverFieldName
	)			raises (SALOME::SALOME_Exception)

Writes a field.

void SALOME_MED.FIELD.addInStudy	(	in SALOMEDS::Study	myStudy,
		in FIELD	myIor
	)			raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection)

Adds the Field in the StudyManager.

void SALOME_MED.FIELD.addInStudyToComponent	(	in SALOMEDS::SComponent	myComponent,
		in FIELD	myIor
	)			raises (SALOME::SALOME_Exception, SALOMEDS::StudyBuilder::LockProtection)

long SALOME_MED.FIELD.getCorbaIndex

(

)

raises (SALOME::SALOME_Exception)

Internal Corba method.