XAO::Step Class Reference

Base class for steps. More...

Inheritance diagram for XAO::Step:

Public Member Functions
virtual	~Step ()
	Destructor. More...
virtual XAO::Type	getType ()=0
	Gets the type of the step. More...
int	getStep ()
	Gets the step index. More...
void	setStep (int step)
	Sets the number of the step. More...
int	getStamp ()
	Gets the stamp of the index. More...
void	setStamp (int stamp)
	Sets the stamp of the index. More...
int	countComponents ()
	Gets the number of components of the step. More...
int	countElements ()
	Gets the number of elements for the step. More...
int	countValues ()
	Gets the number of values for the step. More...
virtual const std::string	getStringValue (int element, int component)=0
	Gets a value as a string. More...
virtual void	setStringValue (int element, int component, const std::string &value)=0
	Sets a value as a string. More...

Protected Member Functions
	Step ()
	Default constructor. More...
void	checkElementIndex (int element)
	Checks that given element index is in the range of element indexes. More...
void	checkComponentIndex (int component)
	Checks that given component index is in the range of component indexes. More...
void	checkNbElements (int nbElements)
	Checks that the given number of elements is correct. More...
void	checkNbComponents (int nbComponents)
	Checks that the given number of components is correct. More...
void	checkNbValues (int nbValues)
	checks that the given number of values is correct. More...

Protected Attributes
int	m_step
	the index of the step. More...
int	m_stamp
	The stamp of the step. More...
int	m_nbComponents
	The number of components. More...
int	m_nbElements
	The number of elements. More...

Detailed Description

Base class for steps.

Constructor & Destructor Documentation

Step()

XAO::Step::Step ( )

inlineprotected

Default constructor.

~Step()

virtual XAO::Step::~Step ( )

inlinevirtual

Destructor.

Member Function Documentation

getType()

virtual XAO::Type XAO::Step::getType ( )

pure virtual

Gets the type of the step.

Returns

Implemented in XAO::StringStep, XAO::IntegerStep, XAO::DoubleStep, and XAO::BooleanStep.

getStep()

int XAO::Step::getStep ( )

inline

Gets the step index.

Returns

the index of the step.

setStep()

void XAO::Step::setStep ( int  step )

inline

Sets the number of the step.

Parameters

step	the index to set.

getStamp()

int XAO::Step::getStamp ( )

inline

Gets the stamp of the index.

Returns

the stamp of the index.

setStamp()

void XAO::Step::setStamp ( int  stamp )

inline

Sets the stamp of the index.

Parameters

stamp

the stamp to set.

countComponents()

int XAO::Step::countComponents ( )

inline

Gets the number of components of the step.

Returns

the number of components.

countElements()

int XAO::Step::countElements ( )

inline

Gets the number of elements for the step.

Returns

the number of elements.

countValues()

int XAO::Step::countValues ( )

inline

Gets the number of values for the step.

Returns

the number of values.

getStringValue()

virtual const std::string XAO::Step::getStringValue ( int  element, int  component  )

pure virtual

Gets a value as a string.

Parameters

element	the index of the element.
component	the index of the component.

Returns

the value as a string.

Implemented in XAO::StringStep, XAO::IntegerStep, XAO::DoubleStep, and XAO::BooleanStep.

setStringValue()

virtual void XAO::Step::setStringValue ( int  element, int  component, const std::string &  value  )

pure virtual

Sets a value as a string.

Parameters

element	the index of the element.
component	the index of the component.
value	the string value.

Exceptions

XAO_Exception

if the value is not valid.

Implemented in XAO::StringStep, XAO::IntegerStep, XAO::DoubleStep, and XAO::BooleanStep.

checkElementIndex()

void Step::checkElementIndex ( int  element )

protected

Checks that given element index is in the range of element indexes.

Parameters

element

the index to check.

checkComponentIndex()

void Step::checkComponentIndex ( int  component )

protected

Checks that given component index is in the range of component indexes.

Parameters

component

the index to check.

checkNbElements()

void Step::checkNbElements ( int  nbElements )

protected

Checks that the given number of elements is correct.

Parameters

nbElements

the number of elements to check.

checkNbComponents()

void Step::checkNbComponents ( int  nbComponents )

protected

Checks that the given number of components is correct.

Parameters

nbComponents

the number of components to check.

checkNbValues()

void Step::checkNbValues ( int  nbValues )

protected

checks that the given number of values is correct.

Parameters

nbValues

the number of values to check.

Field Documentation

m_step

int XAO::Step::m_step

protected

the index of the step.

m_stamp

int XAO::Step::m_stamp

protected

The stamp of the step.

m_nbComponents

int XAO::Step::m_nbComponents

protected

The number of components.

m_nbElements

int XAO::Step::m_nbElements

protected

The number of elements.