Version: 9.12.0
XAO::Field Class Referenceabstract

A geometrical Field.

#include <XAO_Field.hxx>

Inheritance diagram for XAO::Field:
Inheritance graph

Protected Member Functions

 Field (XAO::Dimension dimension, int nbElements, int nbComponents, const std::string &name)
 Constructor. More...
 

the name of the field.

Creates a Field of the given type.

Parameters
typethe type of the field to create.
dimensionthe dimension.
nbElementsthe number of geometrical elements.
nbComponentsthe number of components.
Returns
the created field.
std::string m_name
 The name of the Field. More...
 
XAO::Dimension m_dimension
 The dimension of the Field. More...
 
int m_nbComponents
 The number of components. More...
 
std::vector< std::string > m_components
 The components of the field. More...
 
int m_nbElements
 The number of elements. More...
 
std::vector< Step * > m_steps
 The list of steps. More...
 
void checkComponent (int component)
 
void checkStepIndex (int step)
 
static FieldcreateField (XAO::Type type, XAO::Dimension dimension, int nbElements, int nbComponents, const std::string &name=std::string(""))
 
virtual ~Field ()
 Destructor. More...
 
virtual XAO::Type getType ()=0
 Gets the Type of the field. More...
 
const std::string getName () const
 Gets the name of the Field. More...
 
void setName (const std::string &name)
 Sets the name of the Field. More...
 
XAO::Dimension getDimension () const
 Gets the Dimension of the Field. More...
 
int countElements () const
 Gets the number of elements of each step. More...
 
int countComponents () const
 Gets the number of components. More...
 
int countValues () const
 Gets the number of values for each step. More...
 
int countSteps () const
 Gets the number of the steps. More...
 
const std::string getComponentName (int index)
 Gets the name of a component. More...
 
void setComponentName (int componentIndex, const std::string &name)
 Sets the name of a component. More...
 
void setComponentsNames (const std::vector< std::string > &names)
 Sets the name of the components. More...
 
virtual StepaddNewStep (int number)=0
 Adds a new step of the same type than the field. More...
 
bool removeStep (Step *step)
 Remove a step. More...
 
bool hasStep (int step)
 Verifies if the field has a step with the given step number. More...
 
stepIterator begin ()
 Returns the first step. More...
 
stepIterator end ()
 Returns the last step. More...
 

Constructor & Destructor Documentation

◆ Field()

Field::Field ( XAO::Dimension  dimension,
int  nbElements,
int  nbComponents,
const std::string &  name 
)
protected
Parameters
dimensionthe dimension of the field.
nbElementsthe number of elements.
nbComponentsthe number of components.
namethe name of the field.

◆ ~Field()

Field::~Field ( )
virtual

References m_steps.

Member Function Documentation

◆ addNewStep()

virtual Step* XAO::Field::addNewStep ( int  number)
pure virtual
Parameters
numberthe numer of the step.
Returns
the new create step.

Implemented in XAO::StringField, XAO::IntegerField, XAO::DoubleField, and XAO::BooleanField.

◆ begin()

stepIterator XAO::Field::begin ( )
inline
Returns
an iterator on the first step.

◆ checkComponent()

void Field::checkComponent ( int  component)
protected

References m_nbComponents.

◆ checkStepIndex()

void Field::checkStepIndex ( int  step)
protected

References m_steps.

◆ countComponents()

int XAO::Field::countComponents ( ) const
inline
Returns
the number of components.

◆ countElements()

int XAO::Field::countElements ( ) const
inline
Returns
the number of elements of each step.

◆ countSteps()

int XAO::Field::countSteps ( ) const
inline
Returns
the number of steps.

◆ countValues()

int XAO::Field::countValues ( ) const
inline
Returns
the number of values for each step.

◆ createField()

Field * Field::createField ( XAO::Type  type,
XAO::Dimension  dimension,
int  nbElements,
int  nbComponents,
const std::string &  name = std::string("") 
)
static

◆ end()

stepIterator XAO::Field::end ( )
inline
Returns
an iterator on the last step.

◆ getComponentName()

const std::string Field::getComponentName ( int  index)
Parameters
indexthe index of the component to get.
Returns
the name of the component for the given index.

References checkComponent(), and m_components.

◆ getDimension()

XAO::Dimension XAO::Field::getDimension ( ) const
inline
Returns
the Dimension of the Field.

◆ getName()

const std::string XAO::Field::getName ( ) const
inline
Returns
the name of the Field.

◆ getType()

virtual XAO::Type XAO::Field::getType ( )
pure virtual
Returns
the Type of the field.

Implemented in XAO::StringField, XAO::IntegerField, XAO::DoubleField, and XAO::BooleanField.

◆ hasStep()

bool Field::hasStep ( int  step)
Parameters
stepthe step number.
Returns
true if the field has a step for the given number.

References XAO::Step::getStep(), and m_steps.

◆ removeStep()

bool Field::removeStep ( Step step)
Parameters
stepthe step to remove.
Returns
true if the step has been removed, false otherwise.

References m_steps.

◆ setComponentName()

void Field::setComponentName ( int  componentIndex,
const std::string &  name 
)
Parameters
componentIndexthe index of the component to set.
namethe name to set.

References checkComponent(), and m_components.

◆ setComponentsNames()

void Field::setComponentsNames ( const std::vector< std::string > &  names)
Parameters
namesthe names to set.

References m_components, and m_nbComponents.

◆ setName()

void XAO::Field::setName ( const std::string &  name)
inline
Parameters
namethe name to set.

Member Data Documentation

◆ m_components

std::vector<std::string> XAO::Field::m_components
protected

◆ m_dimension

XAO::Dimension XAO::Field::m_dimension
protected

◆ m_name

std::string XAO::Field::m_name
protected

◆ m_nbComponents

int XAO::Field::m_nbComponents
protected

◆ m_nbElements

int XAO::Field::m_nbElements
protected

◆ m_steps

std::vector<Step*> XAO::Field::m_steps
protected

The documentation for this class was generated from the following files: