faudes::AttributeDiagnoserState Class Reference
[Fault Diagnosis Plug-In]

Implements state estimates for the current status of the generator. More...

#include <diag_attrdiagstate.h>

List of all members.

Public Member Functions

 AttributeDiagnoserState (void)
 Default constructor.
 ~AttributeDiagnoserState (void)
 Destructor.
bool IsDefault (void) const
 Test for default value.
virtual void Clear (void)
 Delete the mDiagnoserStateMap.
const TaIndexSet< DiagLabelSet > & DiagnoserStateMap (void) const
 Get mDiagnoserStateMap.
const TaIndexSet< DiagLabelSet > * DiagnoserStateMapp (void) const
 Get pointer to mDiagnoserStateMap.
void DiagnoserStateMap (const TaIndexSet< DiagLabelSet > &newDiagStateMap)
 Set mDiagnoserStateMap.
void AddStateLabelMapping (Idx state, Idx label)
 Add single value of state estimate to mDiagnoserStateMap.
void AddStateLabelMap (Idx gstate, const DiagLabelSet &labels)
 Add state estimates to mDiagnoserStateMap.
std::string Str (void) const
 Pretty printable string of mDiagnoserStateMap.
bool ExistsState (Idx state) const
 Check whether state estimate exists in mDiagnoserStateMap.

Protected Member Functions

void DoAssign (const AttributeDiagnoserState &rSrc)
 Copy attribute members.
bool DoEqual (const AttributeDiagnoserState &rOther) const
 Test equality.
void DoWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
 Write mDiagnoserStateMap to TokenWriter.
void DoXWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
 Write mDiagnoserStateMap to TokenWriter.
void DoRead (TokenReader &rTr, const std::string &rLabel, const Type *pContext)
 Read mDiagnoserStateMap from TokenReader.

Private Attributes

TaIndexSet< DiagLabelSetmDiagnoserStateMap
 The diagnoser state attribute is a map of state indices of the original generator to their failure label sets.

Detailed Description

Implements state estimates for the current status of the generator.

Definition at line 21 of file diag_attrdiagstate.h.


Constructor & Destructor Documentation

faudes::AttributeDiagnoserState::AttributeDiagnoserState ( void   ) 

Default constructor.

Definition at line 15 of file diag_attrdiagstate.cpp.

faudes::AttributeDiagnoserState::~AttributeDiagnoserState ( void   ) 

Destructor.

Definition at line 23 of file diag_attrdiagstate.cpp.


Member Function Documentation

void faudes::AttributeDiagnoserState::AddStateLabelMap ( Idx  gstate,
const DiagLabelSet labels 
)

Add state estimates to mDiagnoserStateMap.

Parameters:
gstate Index of generator state estimate.
labels Index of associated failure labels.

Definition at line 71 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::AddStateLabelMapping ( Idx  state,
Idx  label 
)

Add single value of state estimate to mDiagnoserStateMap.

Parameters:
state Index of generator state estimate.
label Index of associated failure label.

Definition at line 58 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::Clear ( void   )  [virtual]

Delete the mDiagnoserStateMap.

Reimplemented from faudes::AttributeVoid.

Definition at line 38 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::DiagnoserStateMap ( const TaIndexSet< DiagLabelSet > &  newDiagStateMap  ) 

Set mDiagnoserStateMap.

Parameters:
newDiagStateMap New DiagnoserStateMap

Definition at line 53 of file diag_attrdiagstate.cpp.

const TaIndexSet< DiagLabelSet > & faudes::AttributeDiagnoserState::DiagnoserStateMap ( void   )  const

Get mDiagnoserStateMap.

Returns:
mDiagnoserStateMap

Definition at line 43 of file diag_attrdiagstate.cpp.

const TaIndexSet< DiagLabelSet > * faudes::AttributeDiagnoserState::DiagnoserStateMapp ( void   )  const

Get pointer to mDiagnoserStateMap.

Returns:
Pointer to mDiagnoserStateMap

Definition at line 48 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::DoAssign ( const AttributeDiagnoserState rSrc  )  [protected]

Copy attribute members.

Parameters:
rSrc Source to copy from

Definition at line 27 of file diag_attrdiagstate.cpp.

bool faudes::AttributeDiagnoserState::DoEqual ( const AttributeDiagnoserState rOther  )  const [protected]

Test equality.

Parameters:
rOther Attribute to compare with

Definition at line 136 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::DoRead ( TokenReader rTr,
const std::string &  rLabel,
const Type pContext 
) [protected, virtual]

Read mDiagnoserStateMap from TokenReader.

Parameters:
rTr Reference to TokenReader
rLabel Is ignored. Label of the section is "StateEstimates".
pContext Read context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 123 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::DoWrite ( TokenWriter rTw,
const std::string &  rLabel,
const Type pContext 
) const [protected, virtual]

Write mDiagnoserStateMap to TokenWriter.

Parameters:
rTw Reference to TokenWriter
rLabel Is ignored. Label of the section is "StateEstimates".
pContext Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 111 of file diag_attrdiagstate.cpp.

void faudes::AttributeDiagnoserState::DoXWrite ( TokenWriter rTw,
const std::string &  rLabel,
const Type pContext 
) const [protected, virtual]

Write mDiagnoserStateMap to TokenWriter.

Parameters:
rTw Reference to TokenWriter
rLabel Is ignored. Label of the section is "StateEstimates".
pContext Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 117 of file diag_attrdiagstate.cpp.

bool faudes::AttributeDiagnoserState::ExistsState ( Idx  state  )  const

Check whether state estimate exists in mDiagnoserStateMap.

Parameters:
state Index of state to check.
Returns:
True if state exists.

Definition at line 106 of file diag_attrdiagstate.cpp.

bool faudes::AttributeDiagnoserState::IsDefault ( void   )  const [virtual]

Test for default value.

Returns:
True for default value.

Reimplemented from faudes::AttributeFlags.

Definition at line 33 of file diag_attrdiagstate.cpp.

string faudes::AttributeDiagnoserState::Str ( void   )  const

Pretty printable string of mDiagnoserStateMap.

Returns:
String representation of mDiagnoserStateMap.

Definition at line 88 of file diag_attrdiagstate.cpp.


Member Data Documentation

The diagnoser state attribute is a map of state indices of the original generator to their failure label sets.

The whole map represents one state label of one particular state.

Definition at line 30 of file diag_attrdiagstate.h.


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

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen