Version: 6.5.0
Functions
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)
string MEDMEM::FIELD_::getName ( ) const
void MEDMEM::FIELD_::setDescription ( const string  Description)
string MEDMEM::FIELD_::getDescription ( ) const

Gets FIELD description.

void MEDMEM::FIELD_::setNumberOfComponents ( const int  NumberOfComponents)

Sets FIELD number of components.

int MEDMEM::FIELD_::getNumberOfComponents ( ) const
void MEDMEM::FIELD_::setNumberOfValues ( const int  NumberOfValues)

Sets FIELD number of values.

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

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

Sets FIELD components names.

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

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

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

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

This Array size is equal to number of components

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

Sets FIELD components descriptions.

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

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

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

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

This Array size is equal to number of components

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)

Sets FIELD components unit.

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

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

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

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

This array size is equal to number of components

string MEDMEM::FIELD_::getMEDComponentUnit ( int  i) const
void MEDMEM::FIELD_::setIterationNumber ( int  IterationNumber)
int MEDMEM::FIELD_::getIterationNumber ( ) const

Gets the iteration number where FIELD has been calculated.

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

void MEDMEM::FIELD_::setTime ( double  Time)
double MEDMEM::FIELD_::getTime ( ) const

Gets the time when FIELD has been calculated.

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

void MEDMEM::FIELD_::setOrderNumber ( int  OrderNumber)
int MEDMEM::FIELD_::getOrderNumber ( ) const

Gets the order number where FIELD has been calculated.

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

const SUPPORT * MEDMEM::FIELD_::getSupport ( ) const
void MEDMEM::FIELD_::setSupport ( const SUPPORT support)

Sets the reference to the SUPPORT object associated to FIELD.

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

MED_EN::med_type_champ MEDMEM::FIELD_::getValueType ( ) const

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

MED_EN::medModeSwitch MEDMEM::FIELD_::getInterlacingType ( ) const

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

Copyright © 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS