engage::OutputConfig Class Reference

This holds the input data for the 'output' block. More...

#include <OutputConfig.hpp>

Public Types
enum	Format { cMINIMAL , cBLOCK , cCOLUMN }
	Output format for the slot. More...
typedef std::list< OutputItem >	ItemList
typedef std::list< EventItem >	EventItems

Public Member Functions
	OutputConfig ()
bool	ProcessInput (UtInput &aInput)
void	SetFileName (const std::string &aFileName)
void	SetFormat (Format aFormat)
void	SetPhase (Phase aPhase)
void	SetEventOutput (bool aEventOutput)
void	SetSummaryOutput (bool aSummaryOutput)
void	SetRateTableName (const std::string &aRateTableName)
void	SetRateTable (const OutputRate &aRateTable)
void	AddOutputItem (const OutputItem &aItem)
std::string	GetFileName () const
Format	GetFormat () const
Phase	GetPhase () const
bool	DoEventOutput () const
bool	DoSummaryOutput () const
std::string	GetRateTableName () const
const ItemList &	GetOutputItems () const
const EventItems &	GetEventItems () const
bool	DoPeriodicOutput (Phase aPhase, double aSimTime, double aLastOutputTime) const

Detailed Description

This holds the input data for the 'output' block.

Member Typedef Documentation

EventItems

typedef std::list<EventItem> engage::OutputConfig::EventItems

ItemList

typedef std::list<OutputItem> engage::OutputConfig::ItemList

Member Enumeration Documentation

Format

enum engage::OutputConfig::Format

Output format for the slot.

Enumerator
cMINIMAL	ESAMS minimal format.
cBLOCK	ESAMS block format.
cCOLUMN	ESAMS column format.

Constructor & Destructor Documentation

OutputConfig()

engage::OutputConfig::OutputConfig

(

)

References engage::cALL, and cMINIMAL.

Member Function Documentation

AddOutputItem()

void engage::OutputConfig::AddOutputItem ( const OutputItem & aItem )

inline

DoEventOutput()

bool engage::OutputConfig::DoEventOutput ( ) const

inline

Referenced by engage::TaskOutput::WriteEvent().

DoPeriodicOutput()

bool engage::OutputConfig::DoPeriodicOutput	(	Phase	aPhase,
		double	aSimTime,
		double	aLastOutputTime ) const

Determine if periodic output is to performed at the current time.

Parameters

aPhase	[input] The current simulation phase.
aSimTime	[input] The current simulation time.
aLastOutputTime	[input] The last simulation time when periodic output was last performed.

Returns

'true' if periodic output should be performed, or false if not.

References engage::cALL.

Referenced by engage::TaskOutput::Write().

DoSummaryOutput()

bool engage::OutputConfig::DoSummaryOutput ( ) const

inline

Referenced by engage::TaskOutput::OpenFiles().

GetEventItems()

const EventItems & engage::OutputConfig::GetEventItems ( ) const

inline

Referenced by engage::TaskOutput::WriteEvent().

GetFileName()

std::string engage::OutputConfig::GetFileName ( ) const

inline

Referenced by engage::TaskOutput::OpenFiles().

GetFormat()

Format engage::OutputConfig::GetFormat ( ) const

inline

GetOutputItems()

const ItemList & engage::OutputConfig::GetOutputItems ( ) const

inline

Referenced by engage::TaskOutput::Write().

GetPhase()

Phase engage::OutputConfig::GetPhase ( ) const

inline

GetRateTableName()

std::string engage::OutputConfig::GetRateTableName ( ) const

inline

Referenced by engage::RunConfig::Complete().

ProcessInput()

bool engage::OutputConfig::ProcessInput

(

UtInput &

aInput

)

References engage::cACQUIRING, engage::cALL, engage::cFLYING, engage::cTRACKING, engage::EventItem::ProcessInput(), and engage::OutputItem::ProcessInput().

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

SetEventOutput()

void engage::OutputConfig::SetEventOutput ( bool aEventOutput )

inline

SetFileName()

void engage::OutputConfig::SetFileName ( const std::string & aFileName )

inline

SetFormat()

void engage::OutputConfig::SetFormat ( Format aFormat )

inline

SetPhase()

void engage::OutputConfig::SetPhase ( Phase aPhase )

inline

SetRateTable()

void engage::OutputConfig::SetRateTable ( const OutputRate & aRateTable )

inline

Referenced by engage::RunConfig::Complete().

SetRateTableName()

void engage::OutputConfig::SetRateTableName ( const std::string & aRateTableName )

inline

SetSummaryOutput()

void engage::OutputConfig::SetSummaryOutput ( bool aSummaryOutput )

inline

---

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

• OutputConfig.hpp
• OutputConfig.cpp