Dxc::DiagnosisData Class Reference

Defines the data structure for a Diagnosis. More...

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

Inheritance diagram for Dxc::DiagnosisData:
Dxc::DxcData

List of all members.

Public Member Functions

 DiagnosisData (Timestamp timestamp, bool detectionSignal=false, bool isolationSignal=false, const CandidateSet &isolation=CandidateSet(), const std::string &notes="")
 Constructor to initialize the DiagnosisData with timestamp.
 DiagnosisData (bool detectionSignal=false, bool isolationSignal=false, const CandidateSet &isolation=CandidateSet(), const std::string &notes="")
 Constructor to initialize the DiagnosisData with current time as timestamp.
bool getDetectionSignal () const
 True if, according to the diagnosis, the system is believed to be in a faulty state.
bool getIsolationSignal () const
 True if faults have been isolated, ie. candidates exist.
virtual DiagnosisDataclone () const
 Virtual copy constructor.
virtual std::ostream & put (std::ostream &) const
 Prints DxcData in standardized, parseable format.

Detailed Description

Defines the data structure for a Diagnosis.

A diagnosis is a set of candidates, weighed by their relative probability. The weights of these candidates are normalized upon construction of the datatype, resulting in weights that yield 1 when added together. An additional detection signal and isolation signal indicate whether the reasoner has detected something wrong with the system (detectionSignal = true) and wether it has isolated the fault to specific component failure modes (isolationSignal = true). If the isolationSignal is false, the Candidate set, regardless of its contents, may be effectively treated as empty.


Constructor & Destructor Documentation

DiagnosisData::DiagnosisData ( Timestamp  timestamp,
bool  detectionSignal = false,
bool  isolationSignal = false,
const CandidateSet isolation = CandidateSet(),
const std::string &  notes = "" 
)

Constructor to initialize the DiagnosisData with timestamp.

Parameters:
timestamp - message timestamp.
detectionSignal - set to true if the system is believed to be in a faulty state, even if there is not yet an isolation (CandidateSet).
isolationSignal - set to true if faults have been isolated, ie. candidates exist.
isolation - a set of Candidates (hypotheses). Their weights will be normalized, so that they all add up to one.
notes - A string for Diagnosis Algorithms to supply additional information for their own purposes.
DiagnosisData::DiagnosisData ( bool  detectionSignal = false,
bool  isolationSignal = false,
const CandidateSet isolation = CandidateSet(),
const std::string &  notes = "" 
)

Constructor to initialize the DiagnosisData with current time as timestamp.

Parameters:
detectionSignal - set to true if the system is believed to be in a faulty state, even if there is not yet an isolation (CandidateSet).
isolationSignal - set to true if faults have been isolated, ie. candidates exist.
isolation - a set of Candidates (hypotheses). Their weights will be normalized, so that they all add up to one.
notes - A string for Diagnosis Algorithms to supply additional information for their own purposes.

Member Function Documentation

DiagnosisData * DiagnosisData::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