Basic Get/Set operations

Functions

void MEDMEM::FIELD_::setName (const string Name)
string MEDMEM::FIELD_::getName () const
void MEDMEM::FIELD_::setDescription (const string Description)
string MEDMEM::FIELD_::getDescription () const
void MEDMEM::FIELD_::setNumberOfComponents (const int NumberOfComponents)
int MEDMEM::FIELD_::getNumberOfComponents () const
void MEDMEM::FIELD_::setNumberOfValues (const int NumberOfValues)
int MEDMEM::FIELD_::getNumberOfValues () const
void MEDMEM::FIELD_::setComponentsNames (const string *ComponentsNames)
void MEDMEM::FIELD_::setComponentName (int i, const string ComponentName)
const string * MEDMEM::FIELD_::getComponentsNames () const
string MEDMEM::FIELD_::getComponentName (int i) const
void MEDMEM::FIELD_::setComponentsDescriptions (const string *ComponentsDescriptions)
void MEDMEM::FIELD_::setComponentDescription (int i, const string ComponentDescription)
const string * MEDMEM::FIELD_::getComponentsDescriptions () const
string MEDMEM::FIELD_::getComponentDescription (int i) const
void MEDMEM::FIELD_::setComponentsUnits (const UNIT *ComponentsUnits)
const UNIT * MEDMEM::FIELD_::getComponentsUnits () const
const UNIT * MEDMEM::FIELD_::getComponentUnit (int i) const
void MEDMEM::FIELD_::setMEDComponentsUnits (const string *MEDComponentsUnits)
void MEDMEM::FIELD_::setMEDComponentUnit (int i, const string MEDComponentUnit)
const string * MEDMEM::FIELD_::getMEDComponentsUnits () const
string MEDMEM::FIELD_::getMEDComponentUnit (int i) const
void MEDMEM::FIELD_::setIterationNumber (int IterationNumber)
int MEDMEM::FIELD_::getIterationNumber () const
void MEDMEM::FIELD_::setTime (double Time)
double MEDMEM::FIELD_::getTime () const
void MEDMEM::FIELD_::setOrderNumber (int OrderNumber)
int MEDMEM::FIELD_::getOrderNumber () const
const SUPPORT * MEDMEM::FIELD_::getSupport () const
void MEDMEM::FIELD_::setSupport (const SUPPORT *support)
MED_EN::med_type_champ MEDMEM::FIELD_::getValueType () const
MED_EN::medModeSwitch MEDMEM::FIELD_::getInterlacingType () const

Detailed Description

This sections groups together the basic operations that describe access to all the elements constitutive of the description of the field :

Some of these items are compulsory because they are essential to the field in order to define its structure or to be identified inside a MED file during the write process. The other ones are there for additional information and can be overlooked if not necessary.

When creating a field by reading a file, all the parameters are set according to the file data and can be consulted via the get methods. When creating a file from scratch, the name and number of components are set by the constructor, but the other items have to be set via the setXXX methods.


Function Documentation

void MEDMEM::FIELD_::setName ( const string  Name  )  [inherited]
string MEDMEM::FIELD_::getName (  )  const [inherited]
void MEDMEM::FIELD_::setDescription ( const string  Description  )  [inherited]
string MEDMEM::FIELD_::getDescription (  )  const [inherited]
void MEDMEM::FIELD_::setNumberOfComponents ( const int  NumberOfComponents  )  [inherited]
int MEDMEM::FIELD_::getNumberOfComponents (  )  const [inherited]
void MEDMEM::FIELD_::setNumberOfValues ( const int  NumberOfValues  )  [inherited]

Sets FIELD number of values.

It must be the same than in the associated SUPPORT object.

References MEDMEM::FIELD_::_numberOfValues.

int MEDMEM::FIELD_::getNumberOfValues (  )  const [inherited]
void MEDMEM::FIELD_::setComponentsNames ( const string *  ComponentsNames  )  [inherited]

Sets FIELD components names.

Duplicates the ComponentsNames string array to put components names in FIELD. ComponentsNames size must be equal to number of components.

References MEDMEM::FIELD_::_componentsNames, and MEDMEM::FIELD_::_numberOfComponents.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

void MEDMEM::FIELD_::setComponentName ( int  i,
const string  ComponentName 
) [inherited]
const string * MEDMEM::FIELD_::getComponentsNames (  )  const [inherited]

Gets a reference to the string array which contain the components names.

This Array size is equal to number of components

References MEDMEM::FIELD_::_componentsNames.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

string MEDMEM::FIELD_::getComponentName ( int  i  )  const [inherited]
void MEDMEM::FIELD_::setComponentsDescriptions ( const string *  ComponentsDescriptions  )  [inherited]

Sets FIELD components descriptions.

Duplicates the ComponentsDescriptions string array to put components descriptions in FIELD. ComponentsDescriptions size must be equal to number of components.

References MEDMEM::FIELD_::_componentsDescriptions, and MEDMEM::FIELD_::_numberOfComponents.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

void MEDMEM::FIELD_::setComponentDescription ( int  i,
const string  ComponentDescription 
) [inherited]
const string * MEDMEM::FIELD_::getComponentsDescriptions (  )  const [inherited]

Gets a reference to the string array which contain the components descriptions.

This Array size is equal to number of components

References MEDMEM::FIELD_::_componentsDescriptions.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

string MEDMEM::FIELD_::getComponentDescription ( int  i  )  const [inherited]
void MEDMEM::FIELD_::setComponentsUnits ( const UNIT *  ComponentsUnits  )  [inherited]
const UNIT * MEDMEM::FIELD_::getComponentsUnits (  )  const [inherited]
const UNIT * MEDMEM::FIELD_::getComponentUnit ( int  i  )  const [inherited]
void MEDMEM::FIELD_::setMEDComponentsUnits ( const string *  MEDComponentsUnits  )  [inherited]

Sets FIELD components unit.

Duplicates the MEDComponentsUnits string array to put components units in FIELD. MEDComponentsUnits size must be equal to number of components.

References MEDMEM::FIELD_::_MEDComponentsUnits, and MEDMEM::FIELD_::_numberOfComponents.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

void MEDMEM::FIELD_::setMEDComponentUnit ( int  i,
const string  MEDComponentUnit 
) [inherited]
const string * MEDMEM::FIELD_::getMEDComponentsUnits (  )  const [inherited]

Gets a reference to the string array which contain the components units.

This array size is equal to number of components

References MEDMEM::FIELD_::_MEDComponentsUnits.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::operator-().

string MEDMEM::FIELD_::getMEDComponentUnit ( int  i  )  const [inherited]
void MEDMEM::FIELD_::setIterationNumber ( int  IterationNumber  )  [inherited]
int MEDMEM::FIELD_::getIterationNumber (  )  const [inherited]
void MEDMEM::FIELD_::setTime ( double  Time  )  [inherited]
double MEDMEM::FIELD_::getTime (  )  const [inherited]
void MEDMEM::FIELD_::setOrderNumber ( int  OrderNumber  )  [inherited]
int MEDMEM::FIELD_::getOrderNumber (  )  const [inherited]
const SUPPORT * MEDMEM::FIELD_::getSupport (  )  const [inherited]
void MEDMEM::FIELD_::setSupport ( const SUPPORT support  )  [inherited]

Sets the reference to the SUPPORT object associated to FIELD.

Reference is not duplicate, so it must not be deleted.

References MEDMEM::FIELD_::_support, MEDMEM::SUPPORT::addReference(), and MEDMEM::SUPPORT::removeReference().

MED_EN::med_type_champ MEDMEM::FIELD_::getValueType (  )  const [inherited]

Gets the FIELD med value type (MED_INT32 or MED_REEL64).

References MEDMEM::FIELD_::_valueType.

MED_EN::medModeSwitch MEDMEM::FIELD_::getInterlacingType (  )  const [inherited]

Gets the FIELD med interlacing type (MED_FULL_INTERLACE or MED_NO_INTERLACE).

References MEDMEM::FIELD_::_interlacingType.

Referenced by MEDMEM::FIELD< T, INTERLACING_TAG >::normL1(), and MEDMEM::FIELD< T, INTERLACING_TAG >::normL2().

Generated on Tue Jul 27 21:55:03 2010 for Med Memory Users' Guide by  doxygen 1.6.3