XAO::BooleanField Class Reference

Represents a field with boolean values.

#include <XAO_BooleanField.hxx>

Inheritance diagram for XAO::BooleanField:

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

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

BooleanField()

BooleanField::BooleanField	(	XAO::Dimension	dimension,
		int	nbElements,
		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

addNewStep()

Step * BooleanField::addNewStep ( int  number )

virtual

Parameters

number

the numer of the step.

Returns

the new create step.

Implements XAO::Field.

References addStep().

addStep() [1/2]

BooleanStep * BooleanField::addStep

(

int

step

)

Parameters

step	the number of the step.

Returns

the newly created step.

addStep() [2/2]

BooleanStep * BooleanField::addStep	(	int	step,
		int	stamp
	)

Parameters

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

Returns

the newly created step.

References XAO::Field::hasStep(), XAO::Field::m_nbComponents, XAO::Field::m_nbElements, and XAO::Field::m_steps.

getStep()

BooleanStep * BooleanField::getStep

(

int

index

)

Parameters

index

the index.

Returns

the step for the given index.

References XAO::Field::checkStepIndex(), and XAO::Field::m_steps.

getType()

virtual XAO::Type XAO::BooleanField::getType ( )

inlinevirtual

Returns

the Type of the field.

Implements XAO::Field.

References XAO::BOOLEAN.

---

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

• src/XAO/XAO_BooleanField.hxx
• src/XAO/XAO_BooleanField.cxx