Dxc::DxcData Class Reference

The root of the Dxc data definition hierarchy. More...

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

Inheritance diagram for Dxc::DxcData:
Dxc::CommandData Dxc::DiagnosisData Dxc::ErrorData Dxc::FaultInjectData Dxc::ProfilingData Dxc::RecoveryData Dxc::ScenarioData Dxc::ScenarioStatusData Dxc::SensorData

List of all members.

Public Member Functions

 DxcData (Timestamp timeStamp)
 Constructor.
Timestamp getTimeStamp () const
 Get message timestamp.
void setTimeStamp (Timestamp timeStamp)
 Set timestamp for DxcData.
std::string getSource () const
 Get message source.
void setSource (std::string source)
 Set message source.
virtual DxcDataclone () const =0
 Virtual copy constructor.
virtual std::ostream & put (std::ostream &) const =0
 Prints DxcData in standardized, parseable format.

Static Public Member Functions

static Timestamp currentTime ()
 Static method to obtain current time.

Detailed Description

The root of the Dxc data definition hierarchy.


Constructor & Destructor Documentation

Dxc::DxcData::DxcData ( Timestamp  timeStamp  )  [inline]

Constructor.

Parameters:
timeStamp - The desired timestamp in milliseconds since 1970-1-1 00:00:00 GMT

Member Function Documentation

virtual DxcData* Dxc::DxcData::clone (  )  const [pure virtual]

Virtual copy constructor.

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

Implemented in Dxc::CommandData, Dxc::DiagnosisData, Dxc::ErrorData, Dxc::FaultInjectData, Dxc::ProfilingData, Dxc::RecoveryData, Dxc::ScenarioData, Dxc::ScenarioStatusData, and Dxc::SensorData.

Timestamp DxcData::currentTime (  )  [static]

Static method to obtain current time.

Returns:
The current time in milliseconds since 1970-1-1 00:00:00 GMT
Timestamp Dxc::DxcData::getTimeStamp (  )  const [inline]

Get message timestamp.

Returns:
The message timestamp in milliseconds since 1970-1-1 00:00:00 GMT
void Dxc::DxcData::setTimeStamp ( Timestamp  timeStamp  )  [inline]

Set timestamp for DxcData.

Although timestamps can be freely manipulated by users in local instances of DxcData, they serve only for informative purposes. There is no guarantee that a DxcData message recipient won't overwrite the timestamp with the time of message arrival.

Parameters:
timeStamp - The desired timestamp in milliseconds since 1970-1-1 00:00:00 GMT

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

Generated on 22 Feb 2013 for dxcApi by  doxygen 1.6.1