Dxc::ScenarioStatusData Class Reference
Data structure for scenario status messages.
More...
#include </home/user/DXC_svn/trunk/Src/APIs/cpp/DataTypes/ScenarioStatusData.hpp>
List of all members.
Public Member Functions |
| ScenarioStatusData (Timestamp timestamp, const std::string &status) |
| Constructor.
|
| ScenarioStatusData (const std::string &status) |
| Constructs with timestamp set to current time.
|
std::string | getStatus () const |
| Returns status.
|
virtual ScenarioStatusData * | clone () const |
| Virtual copy constructor.
|
virtual std::ostream & | put (std::ostream &) const |
| Prints DxcData in standardized, parseable format.
|
Static Public Attributes |
static const std::string | SDS_AWAITING_DA = "SDS_AWAITING_DA" |
static const std::string | SR_READY = "SR_READY" |
static const std::string | DA_READY = "DA_READY" |
| A Diagnosis Algorithm sends DA_READY to indicate it's prepared to receive data.
|
static const std::string | STARTED = "SCENARIO_STARTED" |
static const std::string | SDS_ENDED = "SCENARIO_ENDED" |
| Signals scenario end. DAs must finalize and exit properly or risk termination.
|
static const std::string | UNKNOWN = "UNKNOWN" |
Detailed Description
Data structure for scenario status messages.
Constructor & Destructor Documentation
ScenarioStatusData::ScenarioStatusData |
( |
Timestamp |
timestamp, |
|
|
const std::string & |
status | |
|
) |
| | |
ScenarioStatusData::ScenarioStatusData |
( |
const std::string & |
status |
) |
|
Constructs with timestamp set to current time.
- Parameters:
-
Member Function Documentation
Virtual copy constructor.
Returns a pointer to a copy of the DxcData. The user is responsible for managing the memory.
Implements Dxc::DxcData.
Member Data Documentation
Signals scenario end. DAs must finalize and exit properly or risk termination.
The SDS_ENDED message signals the end of the scenario. All processes must clean up and exit. Some time is given to DAs to compute and send final diagnoses (the exact time is determined by the DXC config file), after which they are terminated.
The documentation for this class was generated from the following files:
- /home/user/DXC_svn/trunk/Src/APIs/cpp/DataTypes/ScenarioStatusData.hpp
- /home/user/DXC_svn/trunk/Src/APIs/cpp/DataTypes/ScenarioStatusData.cpp