#include <diag_attrdiagstate.h>

Public Member Functions

 AttributeDiagnoserState (void)
 
 ~AttributeDiagnoserState (void)
 
bool IsDefault (void) const
 
virtual void Clear (void)
 
const TaIndexSet< DiagLabelSet > & DiagnoserStateMap (void) const
 
const TaIndexSet< DiagLabelSet > * DiagnoserStateMapp (void) const
 
void DiagnoserStateMap (const TaIndexSet< DiagLabelSet > &newDiagStateMap)
 
void AddStateLabelMapping (Idx state, Idx label)
 
void AddStateLabelMap (Idx gstate, const DiagLabelSet &labels)
 
std::string Str (void) const
 
bool ExistsState (Idx state) const
 
- Public Member Functions inherited from faudes::AttributeFlags
 AttributeFlags (void)
 
 AttributeFlags (const AttributeFlags &rOther)
 
virtual ~AttributeFlags (void)
 
bool Test (fType mask) const
 
bool TestAll (fType mask) const
 
bool TestSome (fType mask) const
 
bool TestNone (fType mask) const
 
void Set (fType mask)
 
void Clr (fType mask)
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 
 AttributeVoid (const AttributeVoid &rSrcAttr)
 
virtual ~AttributeVoid (void)
 
virtual void SetDefault (void)
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
- Public Member Functions inherited from faudes::Type
 Type (void)
 
 Type (const Type &rType)
 
virtual ~Type (void)
 
virtual TypeNew (void) const
 
virtual TypeCopy (void) const
 
virtual const TypeCast (const Type *pOther) const
 
virtual TypeAssign (const Type &rSrc)
 
Typeoperator= (const Type &rSrc)
 
virtual bool Equal (const Type &rOther) const
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
virtual void Name (const std::string &rName)
 
virtual const std::string & Name (void) const
 
virtual const std::string & TypeName (void) const
 
void Write (const Type *pContext=0) const
 
void Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 
void XWrite (const Type *pContext=0) const
 
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 
void DWrite (const Type *pContext=0) const
 
void DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
void SWrite (TokenWriter &rTw) const
 
void SWrite (void) const
 
std::string ToSText (void) const
 
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 

Protected Member Functions

void DoAssign (const AttributeDiagnoserState &rSrc)
 
bool DoEqual (const AttributeDiagnoserState &rOther) const
 
void DoWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
 
void DoXWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
 
void DoRead (TokenReader &rTr, const std::string &rLabel, const Type *pContext)
 
- Protected Member Functions inherited from faudes::AttributeFlags
void DoAssign (const AttributeFlags &rSrcAttr)
 
bool DoEqual (const AttributeFlags &rOther) const
 
- Protected Member Functions inherited from faudes::AttributeVoid
void DoAssign (const AttributeVoid &rSrcAttr)
 
bool DoEqual (const AttributeVoid &rOther) const
 
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
- Protected Member Functions inherited from faudes::Type
void DoAssign (const Type &rSrc)
 
bool DoEqual (const Type &rOther) const
 
virtual void DoSWrite (TokenWriter &rTw) const
 
virtual const TypeDefinitionTypeDefinitionp (void) const
 
virtual Token XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const
 

Private Attributes

TaIndexSet< DiagLabelSetmDiagnoserStateMap
 

Additional Inherited Members

- Static Public Member Functions inherited from faudes::AttributeVoid
static void Skip (TokenReader &rTr)
 
- Public Attributes inherited from faudes::AttributeFlags
fType mFlags
 
- Static Public Attributes inherited from faudes::AttributeFlags
static const fType mDefFlags =0x0
 

Detailed Description

Implements state estimates for the current status of the generator.

Definition at line 21 of file diag_attrdiagstate.h.

Constructor & Destructor Documentation

◆ AttributeDiagnoserState()

faudes::AttributeDiagnoserState::AttributeDiagnoserState ( void  )

Default constructor.

Definition at line 15 of file diag_attrdiagstate.cpp.

◆ ~AttributeDiagnoserState()

faudes::AttributeDiagnoserState::~AttributeDiagnoserState ( void  )

Destructor.

Definition at line 23 of file diag_attrdiagstate.cpp.

Member Function Documentation

◆ AddStateLabelMap()

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

Add state estimates to mDiagnoserStateMap.

Parameters
gstateIndex of generator state estimate.
labelsIndex of associated failure labels.

Definition at line 71 of file diag_attrdiagstate.cpp.

◆ AddStateLabelMapping()

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

Add single value of state estimate to mDiagnoserStateMap.

Parameters
stateIndex of generator state estimate.
labelIndex of associated failure label.

Definition at line 58 of file diag_attrdiagstate.cpp.

◆ Clear()

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

Delete the mDiagnoserStateMap.

Reimplemented from faudes::AttributeVoid.

Definition at line 38 of file diag_attrdiagstate.cpp.

◆ DiagnoserStateMap() [1/2]

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

Set mDiagnoserStateMap.

Parameters
newDiagStateMapNew DiagnoserStateMap

Definition at line 53 of file diag_attrdiagstate.cpp.

◆ DiagnoserStateMap() [2/2]

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

Get mDiagnoserStateMap.

Returns
mDiagnoserStateMap

Definition at line 43 of file diag_attrdiagstate.cpp.

◆ DiagnoserStateMapp()

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.

◆ DoAssign()

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

Copy attribute members

Parameters
rSrcSource to copy from

Definition at line 27 of file diag_attrdiagstate.cpp.

◆ DoEqual()

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

Test equality

Parameters
rOtherAttribute to compare with

Definition at line 136 of file diag_attrdiagstate.cpp.

◆ DoRead()

void faudes::AttributeDiagnoserState::DoRead ( TokenReader rTr,
const std::string &  rLabel,
const Type pContext 
)
protectedvirtual

Read mDiagnoserStateMap from TokenReader.

Parameters
rTrReference to TokenReader
rLabelIs ignored. Label of the section is "StateEstimates".
pContextRead context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 123 of file diag_attrdiagstate.cpp.

◆ DoWrite()

void faudes::AttributeDiagnoserState::DoWrite ( TokenWriter rTw,
const std::string &  rLabel,
const Type pContext 
) const
protectedvirtual

Write mDiagnoserStateMap to TokenWriter.

Parameters
rTwReference to TokenWriter
rLabelIs ignored. Label of the section is "StateEstimates".
pContextWrite context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 111 of file diag_attrdiagstate.cpp.

◆ DoXWrite()

void faudes::AttributeDiagnoserState::DoXWrite ( TokenWriter rTw,
const std::string &  rLabel,
const Type pContext 
) const
protectedvirtual

Write mDiagnoserStateMap to TokenWriter.

Parameters
rTwReference to TokenWriter
rLabelIs ignored. Label of the section is "StateEstimates".
pContextWrite context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 117 of file diag_attrdiagstate.cpp.

◆ ExistsState()

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

Check whether state estimate exists in mDiagnoserStateMap.

Parameters
stateIndex of state to check.
Returns
True if state exists.

Definition at line 106 of file diag_attrdiagstate.cpp.

◆ IsDefault()

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.

◆ Str()

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

◆ mDiagnoserStateMap

TaIndexSet<DiagLabelSet> faudes::AttributeDiagnoserState::mDiagnoserStateMap
private

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.33c --- 2025.05.15 --- c++ api documentaion by doxygen