Version: 9.12.0
XAO::Step Class Referenceabstract

Base class for steps.

#include <XAO_Step.hxx>

Inheritance diagram for XAO::Step:
Inheritance graph

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...
 

Constructor & Destructor Documentation

◆ Step()

XAO::Step::Step ( )
inlineprotected

◆ ~Step()

virtual XAO::Step::~Step ( )
inlinevirtual

Member Function Documentation

◆ checkComponentIndex()

void Step::checkComponentIndex ( int  component)
protected
Parameters
componentthe index to check.

References m_nbComponents.

◆ checkElementIndex()

void Step::checkElementIndex ( int  element)
protected
Parameters
elementthe index to check.

References m_nbElements.

◆ checkNbComponents()

void Step::checkNbComponents ( int  nbComponents)
protected
Parameters
nbComponentsthe number of components to check.

References m_nbComponents.

◆ checkNbElements()

void Step::checkNbElements ( int  nbElements)
protected
Parameters
nbElementsthe number of elements to check.

References m_nbElements.

◆ checkNbValues()

void Step::checkNbValues ( int  nbValues)
protected
Parameters
nbValuesthe number of values to check.

References m_nbComponents, and m_nbElements.

◆ countComponents()

int XAO::Step::countComponents ( )
inline
Returns
the number of components.

◆ countElements()

int XAO::Step::countElements ( )
inline
Returns
the number of elements.

◆ countValues()

int XAO::Step::countValues ( )
inline
Returns
the number of values.

◆ getStamp()

int XAO::Step::getStamp ( )
inline
Returns
the stamp of the index.

◆ getStep()

int XAO::Step::getStep ( )
inline
Returns
the index of the step.

◆ getStringValue()

virtual const std::string XAO::Step::getStringValue ( int  element,
int  component 
)
pure virtual
Parameters
elementthe index of the element.
componentthe index of the component.
Returns
the value as a string.

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

◆ getType()

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

◆ setStamp()

void XAO::Step::setStamp ( int  stamp)
inline
Parameters
stampthe stamp to set.

◆ setStep()

void XAO::Step::setStep ( int  step)
inline
Parameters
stepthe index to set.

◆ setStringValue()

virtual void XAO::Step::setStringValue ( int  element,
int  component,
const std::string &  value 
)
pure virtual
Parameters
elementthe index of the element.
componentthe index of the component.
valuethe string value.
Exceptions
XAO_Exceptionif the value is not valid.

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

Member Data Documentation

◆ m_nbComponents

int XAO::Step::m_nbComponents
protected

◆ m_nbElements

int XAO::Step::m_nbElements
protected

◆ m_stamp

int XAO::Step::m_stamp
protected

◆ m_step

int XAO::Step::m_step
protected

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