faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr > Class Template Reference
[Fault Diagnosis Plug-In]

Provides the structure and methods to build and handle diagnosers. More...

#include <diag_generator.h>

List of all members.

Public Member Functions

Idx InsFailureTypeMapping (const std::string &failureType, const EventSet &rfailureEvents)
 Adds a failure type with associated failure events to the global attribute.
void InsFailureTypeMap (const std::map< std::string, EventSet > &rFailureMap)
 Insert entire failure type map in the diagnoser.
Idx GetFailureType (Idx failureEvent) const
 Returns the failure type of a particular failure events.
EventSet GetAllFailureEvents (void) const
 Returns the all failure events of the failure partition.
void InsStateLabelMapping (Idx dStateIndex, Idx gStateIndex, Idx labelIndex)
 Inserts a generator state estimate to a diagnoser state.
void InsStateLabelMap (Idx dStateIndex, Idx gState, const DiagLabelSet &labels)
 Inserts a DiagLabelSet containing a complete set of generator state estimates to a diagnoser state.
void SetStateAttr (Idx dStateIndex, const AttributeDiagnoserState &newAttr)
 Set a diagnoser state attribute.
std::string SAStr (Idx dStateIndex) const
 Prints all generator state estimates of a diagnoser state to a string.
void DotWrite (const std::string &rFileName) const
 Writes generator to dot input format.
Constructor, Destructor

 TdiagGenerator (void)
 Creates an emtpy diagnoser.
 TdiagGenerator (const Generator &rOtherGen)
 Construct diagnoser from std generator.
 TdiagGenerator (const TdiagGenerator &rOtherGen)
 Copy constructor.
 TdiagGenerator (const std::string &rFileName)
 Construct from file.
virtual TdiagGeneratorNew (void) const
 Construct on heap.
virtual TdiagGeneratorCopy (void) const
 Construct copy on heap.
 ~TdiagGenerator (void)
 Default destructor.
virtual TdiagGeneratoroperator= (const TdiagGenerator &rOtherGen)
 Assignment operator (uses copy ) Note: you must reimplement this operator in derived classes in order to handle internal pointers correctly.
virtual TdiagGeneratoroperator= (const Generator &rOtherGen)
 Assignment operator (uses copy ).

Private Attributes

SymbolTablempLabelSymbolTable
 Pointer to static LabelSymbolTable of DiagLabelSet.

Detailed Description

template<class GlobalAttr, class StateAttr, class EventAttr, class TransAttr>
class faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >

Provides the structure and methods to build and handle diagnosers.

The diagnoser states carry state estimates for the generator under observation, which are implemented using state attributes.

Definition at line 26 of file diag_generator.h.


Constructor & Destructor Documentation

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::TdiagGenerator ( void   )  [inline]

Creates an emtpy diagnoser.

doxygen group

Definition at line 233 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::TdiagGenerator ( const Generator rOtherGen  )  [inline]

Construct diagnoser from std generator.

Parameters:
rOtherGen 

Definition at line 247 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::TdiagGenerator ( const TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr > &  rOtherGen  )  [inline]

Copy constructor.

Parameters:
rOtherGen 

Definition at line 240 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::TdiagGenerator ( const std::string &  rFileName  )  [inline]

Construct from file.

Parameters:
rFileName Filename
Exceptions:
Exception If opening/reading fails an Exception object is thrown (id 1, 50, 51)

Definition at line 254 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::~TdiagGenerator ( void   )  [inline]

Default destructor.

Definition at line 84 of file diag_generator.h.


Member Function Documentation

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr > * faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::Copy ( void   )  const [inline, virtual]

Construct copy on heap.

Returns:
new Generator

Reimplemented from faudes::TcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 275 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::DotWrite ( const std::string &  rFileName  )  const [inline, virtual]

Writes generator to dot input format.

The dot file format is specified by the graphiz package; see http://www.graphviz.org. The package includes the dot command line tool to generate a graphical representation of the generators graph. See also Generator::GraphWrite(). This functions sets the re-indexing to minimal indices.

Parameters:
rFileName File to write
Exceptions:
Exception 
  • IO errors (id 2)

Reimplemented from faudes::vGenerator.

Definition at line 327 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
EventSet faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::GetAllFailureEvents ( void   )  const [inline]

Returns the all failure events of the failure partition.

Returns:
EventSet containing all failure events.

Definition at line 300 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::GetFailureType ( Idx  failureEvent  )  const [inline]

Returns the failure type of a particular failure events.

Parameters:
failureEvent A failure event.
Returns:
Index of failure type in msLabelSymbolTable.

Definition at line 295 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsFailureTypeMap ( const std::map< std::string, EventSet > &  rFailureMap  )  [inline]

Insert entire failure type map in the diagnoser.

Parameters:
rFailureMap Map of failure type names to failure events.

Definition at line 289 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
Idx faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsFailureTypeMapping ( const std::string &  failureType,
const EventSet rfailureEvents 
) [inline]

Adds a failure type with associated failure events to the global attribute.

If failure type does already exists the failure events are overridden.

Parameters:
failureType Name of failure type.
rfailureEvents Associated failure events.
Returns:
Index of failure type in msLabelSymbolTable of DiagLabelSet

Definition at line 284 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsStateLabelMap ( Idx  dStateIndex,
Idx  gState,
const DiagLabelSet labels 
) [inline]

Inserts a DiagLabelSet containing a complete set of generator state estimates to a diagnoser state.

Parameters:
dStateIndex Index of diagnoser state.
gState Index of generator state estimate.
labels Associated DiagLabelSet containing the generator state estimates.

Definition at line 311 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::InsStateLabelMapping ( Idx  dStateIndex,
Idx  gStateIndex,
Idx  labelIndex 
) [inline]

Inserts a generator state estimate to a diagnoser state.

Parameters:
dStateIndex Index of diagnoser state.
gStateIndex Index of generator state estimate.
labelIndex Index of associated label.

Definition at line 305 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr > * faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::New ( void   )  const [inline, virtual]

Construct on heap.

Returns:
new Generator

Reimplemented from faudes::TcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 262 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
virtual TdiagGenerator& faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::operator= ( const Generator rOtherGen  )  [inline, virtual]

Assignment operator (uses copy ).

Parameters:
rOtherGen Other generator

Reimplemented from faudes::TcGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >.

Definition at line 104 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
virtual TdiagGenerator& faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::operator= ( const TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr > &  rOtherGen  )  [inline, virtual]

Assignment operator (uses copy ) Note: you must reimplement this operator in derived classes in order to handle internal pointers correctly.

Parameters:
rOtherGen Other generator

Definition at line 96 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
std::string faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::SAStr ( Idx  dStateIndex  )  const [inline]

Prints all generator state estimates of a diagnoser state to a string.

Parameters:
dStateIndex Index of diagnoser state.
Returns:
String containing state estimates.

Definition at line 322 of file diag_generator.h.

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
void faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::SetStateAttr ( Idx  dStateIndex,
const AttributeDiagnoserState newAttr 
) [inline]

Set a diagnoser state attribute.

Parameters:
dStateIndex Index of diagnoser state.
newAttr The new attribute.

Definition at line 317 of file diag_generator.h.


Member Data Documentation

template<class GlobalAttr , class StateAttr , class EventAttr , class TransAttr >
SymbolTable* faudes::TdiagGenerator< GlobalAttr, StateAttr, EventAttr, TransAttr >::mpLabelSymbolTable [private]

Pointer to static LabelSymbolTable of DiagLabelSet.

Definition at line 30 of file diag_generator.h.


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

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