org.dxc.api.datatypes
Class DiagnosisData

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

public class DiagnosisData
extends DxcData

Defines the data structure for a test article's 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 Summary
DiagnosisData(boolean detectionSignal, boolean isolationSignal, CandidateSet candidateSet, String notes)
          Constructor to initialize the DiagnosisData.
DiagnosisData(long timestamp, boolean detectionSignal, boolean isolationSignal, CandidateSet candidateSet, String notes)
          Constructor to initialize the DiagnosisData.
DiagnosisData(long timestamp, boolean detectionSignal, boolean isolationSignal, List<FaultSet> candidates, List<Double> weights, String notes)
           
 
Method Summary
 boolean equals(Object o)
           
 Set<Candidate> getCandidateSet()
          Returns the set of candidates.
 boolean getDetectionSignal()
          True if, according to the diagnosis, the system is believed to be in a faulty state.
 boolean getIsolationSignal()
          True if faults have been isolated, ie.
 String getNotes()
          Returns test-article-specific notes.
 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
 

Constructor Detail

DiagnosisData

public DiagnosisData(boolean detectionSignal,
                     boolean isolationSignal,
                     CandidateSet candidateSet,
                     String notes)
Constructor to initialize the DiagnosisData.

Parameters:
detectionSignal - Set to true if the system is believed to be in a faulty state, even if there is not yet an isolation.
isolationSignal - Set to true if faults have been isolated, ie. candidates exist.
candidateSet - 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

public DiagnosisData(long timestamp,
                     boolean detectionSignal,
                     boolean isolationSignal,
                     CandidateSet candidateSet,
                     String notes)
Constructor to initialize the DiagnosisData.

Parameters:
detectionSignal - Set to true if the system is believed to be in a faulty state, even if there is not yet an isolation.
isolationSignal - Set to true if faults have been isolated, ie. candidates exist.
candidateSet - 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

public DiagnosisData(long timestamp,
                     boolean detectionSignal,
                     boolean isolationSignal,
                     List<FaultSet> candidates,
                     List<Double> weights,
                     String notes)
Method Detail

getDetectionSignal

public boolean getDetectionSignal()
True if, according to the diagnosis, the system is believed to be in a faulty state.


getIsolationSignal

public boolean getIsolationSignal()
True if faults have been isolated, ie. candidates exist.


getNotes

public String getNotes()
Returns test-article-specific notes.


getCandidateSet

public Set<Candidate> getCandidateSet()
Returns the set of candidates.


equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class DxcData

put

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

Specified by:
put in class DxcData