engage::OutputItem Class Reference

#include <OutputItem.hpp>

Public Types
enum	ItemType {   cREAL_VARIABLE , cINTEGER_VARIABLE , cSTRING_VARIABLE , cLITERAL ,   cNEW_LINE }

Public Member Functions
	OutputItem ()
bool	ProcessInput (UtInput &aInput)
void	SetRealVariable (size_t aVariableIndex, double aScaleFactor)
void	DoOutput (std::ostream &aStream, Simulation &aSimulation) const

Public Attributes
ItemType	mItemType
size_t	mVariableIndex
std::string	mFormat
std::string	mLiteral
double	mScaleFactor

Detailed Description

This represents a single item in an output record.

While something more complex could be implement, it was kept simple so it could be maintained in STL containers and could be easily copy constructed. The aren't all that many of these so space really isn't an issue.

Member Enumeration Documentation

ItemType

enum engage::OutputItem::ItemType

Enumerator
cREAL_VARIABLE
cINTEGER_VARIABLE
cSTRING_VARIABLE
cLITERAL
cNEW_LINE

Constructor & Destructor Documentation

OutputItem()

engage::OutputItem::OutputItem

(

)

References cNEW_LINE, mFormat, mItemType, mLiteral, mScaleFactor, and mVariableIndex.

Member Function Documentation

DoOutput()

void engage::OutputItem::DoOutput	(	std::ostream &	aStream,
		Simulation &	aSimulation ) const

References cINTEGER_VARIABLE, cLITERAL, cNEW_LINE, cREAL_VARIABLE, cSTRING_VARIABLE, engage::Variables::GetIntegerValue(), engage::Variables::GetRealValue(), engage::Variables::GetStringValue(), mFormat, mItemType, mLiteral, mScaleFactor, and mVariableIndex.

ProcessInput()

bool engage::OutputItem::ProcessInput

(

UtInput &

aInput

)

References cINTEGER_VARIABLE, cLITERAL, cNEW_LINE, cREAL_VARIABLE, cSTRING_VARIABLE, engage::Variables::FindIntegerVariable(), engage::Variables::FindRealVariable(), engage::Variables::FindStringVariable(), engage::Variables::GetScaleFactor(), mFormat, mItemType, mLiteral, mScaleFactor, and mVariableIndex.

Referenced by engage::OutputConfig::ProcessInput().

SetRealVariable()

void engage::OutputItem::SetRealVariable ( size_t aVariableIndex, double aScaleFactor )

inline

References cREAL_VARIABLE, mItemType, mScaleFactor, and mVariableIndex.

Member Data Documentation

mFormat

std::string engage::OutputItem::mFormat

Referenced by DoOutput(), OutputItem(), and ProcessInput().

mItemType

ItemType engage::OutputItem::mItemType

Referenced by DoOutput(), OutputItem(), ProcessInput(), and SetRealVariable().

mLiteral

std::string engage::OutputItem::mLiteral

Referenced by DoOutput(), OutputItem(), and ProcessInput().

mScaleFactor

double engage::OutputItem::mScaleFactor

Referenced by DoOutput(), OutputItem(), ProcessInput(), and SetRealVariable().

mVariableIndex

size_t engage::OutputItem::mVariableIndex

Referenced by DoOutput(), OutputItem(), ProcessInput(), and SetRealVariable().

---

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

• OutputItem.hpp
• OutputItem.cpp