XAO::StringField Class Reference

Represents a field with string values.

#include <XAO_StringField.hxx>

Inheritance diagram for XAO::StringField:

Public Member Functions
	StringField (const XAO::Dimension &dimension, const int &nbElements, const int &nbComponents, const std::string &name)
	Constructor. More...
virtual const XAO::Type	getType ()
	Gets the Type of the field. More...
virtual Step *	addNewStep (const int &step) throw (XAO_Exception)
	Adds a new step of the same type than the field. More...
StringStep *	addStep (const int &step) throw (XAO_Exception)
	Adds a new step. More...
StringStep *	addStep (const int &step, const int &stamp) throw (XAO_Exception)
	Adds a new step. More...
StringStep *	getStep (const int &index) throw (XAO_Exception)
	Gets the step of given index. More...
Public Member Functions inherited from XAO::Field
virtual	~Field ()
	Destructor. 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...
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...

Additional Inherited Members
Static Public Member Functions inherited from XAO::Field
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)
Protected Member Functions inherited from XAO::Field
	Field (const XAO::Dimension &dimension, const int &nbElements, const int &nbComponents, const std::string &name)
	Constructor. More...
void	checkComponent (const int &component) throw (XAO_Exception)
void	checkStepIndex (const int &step) throw (XAO_Exception)
Protected Attributes inherited from XAO::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...

Constructor & Destructor Documentation

StringField::StringField	(	const XAO::Dimension &	dimension,
		const int &	nbElements,
		const int &	nbComponents,
		const std::string &	name
	)

Parameters

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

Member Function Documentation

Step * StringField::addNewStep ( const int &  number ) throw (XAO_Exception)

virtual

Parameters

number

the numer of the step.

Returns

the new create step.

Implements XAO::Field.

StringStep * StringField::addStep

(

const int &

step

)

throw (XAO_Exception)

Parameters

step	the number of the step.

Returns

the newly created step.

StringStep * StringField::addStep	(	const int &	step,
		const int &	stamp
	)		throw (XAO_Exception)

Parameters

step	the number of the step.
stamp	the stamp of the step.

Returns

the newly created step.

StringStep * StringField::getStep

(

const int &

index

)

throw (XAO_Exception)

Parameters

index

the index of the step.

Returns

the step for the given index.

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

inlinevirtual

Returns

the Type of the field.

Implements XAO::Field.

References XAO::STRING.

---

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

• src/XAO/XAO_StringField.hxx
• src/XAO/XAO_StringField.cxx