Base class for steps.

#include <XAO_Step.hxx>

Inheritance diagram for XAO::Step:

Public Member Functions
virtual	~Step ()
	Destructor. More...

virtual const XAO::Type	getType ()=0
	Gets the type of the step. More...

const int	getStep ()
	Gets the step index. More...

void	setStep (const int &step)
	Sets the number of the step. More...

const int	getStamp ()
	Gets the stamp of the index. More...

void	setStamp (const int &stamp)
	Sets the stamp of the index. More...

const int	countComponents ()
	Gets the number of components of the step. More...

const int	countElements ()
	Gets the number of elements for the step. More...

const int	countValues ()
	Gets the number of values for the step. More...

virtual const std::string	getStringValue (const int &element, const int &component)=0
	Gets a value as a string. More...

virtual void	setStringValue (const int &element, const int &component, const std::string &value)=0
	Sets a value as a string. More...

Protected Member Functions
	Step ()
	Default constructor. More...

void	checkElementIndex (const int &element) throw (XAO_Exception)
	Checks that given element index is in the range of element indexes. More...

void	checkComponentIndex (const int &component) throw (XAO_Exception)
	Checks that given component index is in the range of component indexes. More...

void	checkNbElements (const int &nbElements) throw (XAO_Exception)
	Checks that the given number of elements is correct. More...

void	checkNbComponents (const int &nbComponents) throw (XAO_Exception)
	Checks that the given number of components is correct. More...

void	checkNbValues (const int &nbValues) throw (XAO_Exception)
	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...

Constructor & Destructor Documentation

XAO::Step::Step ( )

inlineprotected

virtual XAO::Step::~Step ( )

inlinevirtual

Member Function Documentation

void Step::checkComponentIndex ( const int & component ) throw (XAO_Exception)

protected

Parameters

component the index to check.

void Step::checkElementIndex ( const int & element ) throw (XAO_Exception)

protected

Parameters

element the index to check.

void Step::checkNbComponents ( const int & nbComponents ) throw (XAO_Exception)

protected

Parameters

nbComponents the number of components to check.

void Step::checkNbElements ( const int & nbElements ) throw (XAO_Exception)

protected

Parameters

nbElements the number of elements to check.

void Step::checkNbValues ( const int & nbValues ) throw (XAO_Exception)

protected

Parameters

nbValues the number of values to check.

const int XAO::Step::countComponents ( )

inline

Returns: the number of components.

const int XAO::Step::countElements ( )

inline

Returns: the number of elements.

const int XAO::Step::countValues ( )

inline

Returns: the number of values.

const int XAO::Step::getStamp ( )

inline

Returns: the stamp of the index.

const int XAO::Step::getStep ( )

inline

Returns: the index of the step.

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

pure virtual

Parameters

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

Returns: the value as a string.

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

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

pure virtual

Returns

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

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

inline

Parameters

stamp the stamp to set.

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

inline

Parameters

step	the index to set.

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

pure virtual

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::BooleanStep, XAO::IntegerStep, XAO::StringStep, and XAO::DoubleStep.

Member Data Documentation

int XAO::Step::m_nbComponents

protected

int XAO::Step::m_nbElements

protected

int XAO::Step::m_stamp

protected

int XAO::Step::m_step

protected

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

src/XAO/XAO_Step.hxx
src/XAO/XAO_Step.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation