XAO::Field Class Reference

A geometrical Field.

#include <XAO_Field.hxx>

Inheritance diagram for XAO::Field:

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

the name of the field.
Creates a Field of the given type. Parameters type the type of the field to create. dimension the dimension. nbElements the number of geometrical elements. nbComponents the 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 (const int &component) throw (XAO_Exception)
void	checkStepIndex (const int &step) throw (XAO_Exception)
static Field *	createField (const XAO::Type &type, const XAO::Dimension &dimension, const int &nbElements, const int &nbComponents, const std::string &name=std::string("")) throw (XAO_Exception)
virtual	~Field ()
	Destructor. More...
virtual const 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...
const XAO::Dimension	getDimension () const
	Gets the Dimension of the Field. More...
const int	countElements () const
	Gets the number of elements of each step. More...
const int	countComponents () const
	Gets the number of components. More...
const int	countValues () const
	Gets the number of values for each step. More...
const int	countSteps () const
	Gets the number of the steps. More...
const std::string	getComponentName (const int &index) throw (XAO_Exception)
	Gets the name of a component. More...
void	setComponentName (const int &componentIndex, const std::string &name) throw (XAO_Exception)
	Sets the name of a component. More...
void	setComponentsNames (const std::vector< std::string > &names) throw (XAO_Exception)
	Sets the name of the components. More...
virtual Step *	addNewStep (const int &number)=0 throw (XAO_Exception)
	Adds a new step of the same type than the field. More...
bool	removeStep (Step *step)
	Remove a step. More...
bool	hasStep (const 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 ( const XAO::Dimension &  dimension, const int &  nbElements, const int &  nbComponents, const std::string &  name  )

protected

Parameters

dimension	the dimension ot the field.
nbElements	the number of elements.
nbComponents	the number of components.
name	the name of the field.

Field::~Field ( )

virtual

References m_steps.

Member Function Documentation

virtual Step* XAO::Field::addNewStep ( const int &  number ) throw (XAO_Exception)

pure virtual

Parameters

number

the numer of the step.

Returns

the new create step.

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

stepIterator XAO::Field::begin ( )

inline

Returns

an iterator on the first step.

void Field::checkComponent ( const int &  component ) throw (XAO_Exception)

protected

void Field::checkStepIndex ( const int &  step ) throw (XAO_Exception)

protected

const int XAO::Field::countComponents ( ) const

inline

Returns

the number of components.

const int XAO::Field::countElements ( ) const

inline

Returns

the number of elements of each step.

const int XAO::Field::countSteps ( ) const

inline

Returns

the number of steps.

const int XAO::Field::countValues ( ) const

inline

Returns

the number of values for each step.

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

static

References XAO::BOOLEAN, XAO::DOUBLE, XAO::INTEGER, and XAO::STRING.

stepIterator XAO::Field::end ( )

inline

Returns

an iterator on the last step.

const std::string Field::getComponentName

(

const int &

index

)

throw (XAO_Exception)

Parameters

index

the index of the component to get.

Returns

the name of the component for the given index.

const XAO::Dimension XAO::Field::getDimension ( ) const

inline

Returns

the Dimension of the Field.

const std::string XAO::Field::getName ( ) const

inline

Returns

the name of the Field.

virtual const XAO::Type XAO::Field::getType ( )

pure virtual

Returns

the Type of the field.

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

bool Field::hasStep

(

const int &

step

)

Parameters

step	the step number.

Returns

true if the field has a step for the given number.

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

bool Field::removeStep

(

Step *

step

)

Parameters

step	the step to remove.

Returns

true if the step has been removed, false otherwise.

References it(), and m_steps.

void Field::setComponentName	(	const int &	componentIndex,
		const std::string &	name
	)		throw (XAO_Exception)

Parameters

componentIndex	the index of the component to set.
name	the name to set.

void Field::setComponentsNames

(

const std::vector< std::string > &

names

)

throw (XAO_Exception)

Parameters

names

the names to set.

void XAO::Field::setName ( const std::string &  name )

inline

Parameters

name	the name to set.

Member Data Documentation

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

protected

XAO::Dimension XAO::Field::m_dimension

protected

std::string XAO::Field::m_name

protected

int XAO::Field::m_nbComponents

protected

int XAO::Field::m_nbElements

protected

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

protected

---

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

• src/XAO/XAO_Field.hxx
• src/XAO/XAO_Field.cxx