Dxc::ScenarioData Class Reference

Data structure for scenario status messages. More...

#include </home/user/DXC_svn/trunk/Src/APIs/cpp/DataTypes/ScenarioData.hpp>

Inheritance diagram for Dxc::ScenarioData:
Dxc::DxcData

List of all members.

Public Member Functions

 ScenarioData (Timestamp timestamp, const std::string &scenName, const std::string &sysName, const std::string &sysVers, const std::string &daName, const std::string &daVersion, const std::string &fwVers, const long len, const std::string &notes)
 Constructor.
 ScenarioData (const std::string &scenName, const std::string &sysName, const std::string &sysVers, const std::string &daName, const std::string &daVersion, const std::string &fwVers, const long len, const std::string &notes)
 Constructs with timestamp set to current time.
std::string getScenarioName () const
 Returns scenario name.
void setScenarioName (const std::string &scenName)
 Sets scenario name.
std::string getSystemName () const
 Returns system name.
void setSystemName (const std::string &sysName)
 Sets system name.
std::string getSystemVersion () const
 Returns system version.
void setSystemVersion (const std::string &sysVers)
 Sets system version.
std::string getDAName () const
 Returns DA Name.
void setDAName (const std::string &daName)
 Sets DA Name.
std::string getDAVersion () const
 Returns DA Version.
void setDAVersion (const std::string &daVers)
 Sets DA Version.
std::string getFrameworkVersion () const
 Returns framework version.
void setFrameworkVersion (const std::string &fwVers)
 Sets framework version.
long getScenarioLength () const
 Returns scenario length.
void setScenarioLength (long scenLen)
 Sets scenario length.
std::string getNotes () const
 Returns miscellaneous notes.
void setNotes (const std::string &notes)
 Sets miscellaneous notes.
virtual ScenarioDataclone () const
 Virtual copy constructor.
virtual std::ostream & put (std::ostream &) const
 Prints DxcData in standardized, parseable format.

Detailed Description

Data structure for scenario status messages.


Constructor & Destructor Documentation

ScenarioData::ScenarioData ( Timestamp  timestamp,
const std::string &  scenName,
const std::string &  sysName,
const std::string &  sysVers,
const std::string &  daName,
const std::string &  daVersion,
const std::string &  fwVers,
const long  len,
const std::string &  notes 
)

Constructor.

Parameters:
timestamp - message timestamp.
systemName - system name
systemVersion - system version
frameworkVersion - framework version
scenarioName - scenario name
daName - name of DA
daVersion - DA version
scenarioLength - length of scenario
notes - miscellaneous notes
ScenarioData::ScenarioData ( const std::string &  scenName,
const std::string &  sysName,
const std::string &  sysVers,
const std::string &  daName,
const std::string &  daVersion,
const std::string &  fwVers,
const long  len,
const std::string &  notes 
)

Constructs with timestamp set to current time.

Parameters:
systemName - system name
systemVersion - system version
frameworkVersion - framework version
scenarioName - scenario name
daName - name of DA
daVersion - DA version
scenarioLength - length of scenario
notes - miscellaneous notes

Member Function Documentation

ScenarioData * ScenarioData::clone (  )  const [virtual]

Virtual copy constructor.

Returns a pointer to a copy of the DxcData. The user is responsible for managing the memory.

Implements Dxc::DxcData.


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

Generated on 22 Feb 2013 for dxcApi by  doxygen 1.6.1