org.dxc.api.datatypes
Class ScenarioStatusData

Object
  extended by org.dxc.api.datatypes.DxcData
      extended by org.dxc.api.datatypes.ScenarioStatusData

public class ScenarioStatusData
extends DxcData

Data structure for scenario status messages.


Field Summary
static String DA_ENDED
           
static String DA_READY
          A Diagnosis Algorithm sends DA_READY to indicate it's prepared to receive data.
static String ENDED
          Signals scenario end, DAs must finalize and exit properly or risk termination.
static String SDS_AWAITING_DA
           
static String SR_READY
           
static String STARTED
           
static String UNKNOWN
           
 
Constructor Summary
ScenarioStatusData(long timestamp, String status)
          Constructor.
ScenarioStatusData(String status)
          Constructs with timestamp set to current time.
 
Method Summary
 boolean equals(Object o)
           
 String getStatus()
          Returns status.
 int hashCode()
           
 OutputStream put(OutputStream os)
          Prints DxcData.
 
Methods inherited from class org.dxc.api.datatypes.DxcData
getCurrentTime, getSource, getTimeStamp, setSource, setTimeStamp, toString
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SDS_AWAITING_DA

public static final String SDS_AWAITING_DA
See Also:
Constant Field Values

SR_READY

public static final String SR_READY
See Also:
Constant Field Values

DA_READY

public static final String DA_READY
A Diagnosis Algorithm sends DA_READY to indicate it's prepared to receive data.

See Also:
Constant Field Values

STARTED

public static final String STARTED
See Also:
Constant Field Values

ENDED

public static final String ENDED
Signals scenario end, DAs must finalize and exit properly or risk termination. 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.

See Also:
Constant Field Values

DA_ENDED

public static final String DA_ENDED
See Also:
Constant Field Values

UNKNOWN

public static final String UNKNOWN
See Also:
Constant Field Values
Constructor Detail

ScenarioStatusData

public ScenarioStatusData(long timestamp,
                          String status)
Constructor.

Parameters:
timestamp - - message timestamp.
status - - current scenario status (ScenarioStatusData::STARTED, ScenarioStatusData::ENDED, etc).

ScenarioStatusData

public ScenarioStatusData(String status)
Constructs with timestamp set to current time.

Parameters:
status - - current scenario status (ScenarioStatusData::STARTED, ScenarioStatusData::ENDED, etc).
Method Detail

getStatus

public String getStatus()
Returns status.


put

public OutputStream put(OutputStream os)
Description copied from class: DxcData
Prints DxcData.

Specified by:
put in class DxcData

equals

public boolean equals(Object o)
Overrides:
equals in class DxcData

hashCode

public int hashCode()
Overrides:
hashCode in class DxcData