libFAUDES

Sections

Index

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

#include <diag_attrfailureevents.h>

Inherits faudes::AttributeFlags.

List of all members.


Detailed Description

Stores the failure and indicator events for a particular failure type.

Definition at line 19 of file diag_attrfailureevents.h.


Public Member Functions

virtual AttributeFailureEventsNew (void) const
 Construct on heap.
virtual AttributeFailureEventsCopy (void) const
 Construct on heap.
virtual const
AttributeFailureEvents
Cast (const Type *pOther) const
 Cast other object to this type.
virtual AttributeFailureEventsAssign (const Type &rSrc)
 Assign configuration data from other object.
virtual bool Equal (const Type &rOther) const
 Test equality of configuration data.
virtual AttributeFailureEventsoperator= (const AttributeFailureEvents &rSrc)
virtual bool operator== (const AttributeFailureEvents &rOther) const
virtual bool operator!= (const AttributeFailureEvents &rOther) const
 AttributeFailureEvents (void)
 Default constructor.
 ~AttributeFailureEvents (void)
 Default destructor.
bool IsDefault (void) const
 Test for default values of failure and indicator events.
virtual void Clear (void)
 Clears failure and indicator events.

Public Attributes

EventSet mFailureEvents
 Set of failure events.
EventSet mIndicatorEvents
 Set of indicator events.

Protected Member Functions

virtual AttributeFailureEventsDoAssign (const AttributeFailureEvents &rSrcAttr)
 Copy attribute members.
virtual bool DoEuqal (const AttributeFailureEvents &rAttr) const
 Test equality.
void DoWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
 Write failure and indicator events.
void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Read failure and indicator events.

Constructor & Destructor Documentation

faudes::AttributeFailureEvents::AttributeFailureEvents ( void   )  [inline]

Default constructor.

Definition at line 32 of file diag_attrfailureevents.h.

faudes::AttributeFailureEvents::~AttributeFailureEvents ( void   )  [inline]

Default destructor.

Definition at line 34 of file diag_attrfailureevents.h.


Member Function Documentation

AttributeFailureEvents * faudes::AttributeFailureEvents::New ( void   )  const [virtual]

Construct on heap.

Technically not a constructor, this function creates an object with the same type Type. New() is defined as a virtual function and derived classes are meant to re-implement with the appropiate constructor. This can be done via the provided macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION. As with new, it is the callers reponsabilty to delete the object when no longer needed.

Returns:
Pointer to new Type object

Reimplemented from faudes::AttributeFlags.

Definition at line 12 of file diag_attrfailureevents.cpp.

AttributeFailureEvents * faudes::AttributeFailureEvents::Copy ( void   )  const [virtual]

Construct on heap.

Technically not a constructor, this function creates an object with the same type Type and the same configuration. Copy() is defined as a virtual function and derived classes are meant to re-implement with the appropiate copy constructor. This can be done via the provided macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION. As with new, it is the callers reponsabilty to delete the object when no longer needed.

Returns:
Pointer to new Type object

Reimplemented from faudes::AttributeFlags.

Definition at line 12 of file diag_attrfailureevents.cpp.

const AttributeFailureEvents * faudes::AttributeFailureEvents::Cast ( const Type pOther  )  const [virtual]

Cast other object to this type.

Enables the run-time interface to test whether pObject is derived from this object. This feature is used e.g. in the faudes container classes to test attributes. Derived classes must reimplement this function using the appropriate dynamic cast.

Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Returns:
Typed pointer object

Reimplemented from faudes::AttributeFlags.

Definition at line 12 of file diag_attrfailureevents.cpp.

AttributeFailureEvents & faudes::AttributeFailureEvents::Assign ( const Type rSrc  )  [virtual]

Assign configuration data from other object.

Derived classes should reimplement this method to first try to cast the source to the respective class. If successful, the protected function DoAssign is invoked to perform the actual assignment. If the cast fails, the Assign method of the parent class is called. Thus, faudes objects are up- and downcatsted for assignment, maintaining as much of the source data as digestable by the destination object. On the downside, there is no sensible typechecking at compile-time.

Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters:
rSrc Source to copy from
Returns:
Reference to this object.

Reimplemented from faudes::AttributeFlags.

Definition at line 12 of file diag_attrfailureevents.cpp.

bool faudes::AttributeFailureEvents::Equal ( const Type rOther  )  const [virtual]

Test equality of configuration data.

Derived classes should reimplement this method to return true if both actual types and configuration data match. The object name is not consired in the test.

This method calls the virtual method DoEqual(). Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters:
rOther Other objevt to compare with.
Returns:
True on match.

Reimplemented from faudes::AttributeFlags.

Definition at line 12 of file diag_attrfailureevents.cpp.

AttributeFailureEvents & faudes::AttributeFailureEvents::operator= ( const AttributeFailureEvents rSrc  )  [virtual]

Definition at line 12 of file diag_attrfailureevents.cpp.

bool faudes::AttributeFailureEvents::operator== ( const AttributeFailureEvents rOther  )  const [virtual]

Definition at line 12 of file diag_attrfailureevents.cpp.

bool faudes::AttributeFailureEvents::operator!= ( const AttributeFailureEvents rOther  )  const [virtual]

Definition at line 12 of file diag_attrfailureevents.cpp.

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

Test for default values of failure and indicator events.

Returns:
True for default value.

Reimplemented from faudes::AttributeFlags.

Definition at line 35 of file diag_attrfailureevents.cpp.

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

Clears failure and indicator events.

Reimplemented from faudes::AttributeVoid.

Definition at line 40 of file diag_attrfailureevents.cpp.

AttributeFailureEvents & faudes::AttributeFailureEvents::DoAssign ( const AttributeFailureEvents rSrcAttr  )  [protected, virtual]

Copy attribute members.

Parameters:
rSrcAttr Source to copy from

Definition at line 15 of file diag_attrfailureevents.cpp.

bool faudes::AttributeFailureEvents::DoEuqal ( const AttributeFailureEvents rAttr  )  const [protected, virtual]

Test equality.

Parameters:
rAttr Source to copy from

Definition at line 24 of file diag_attrfailureevents.cpp.

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

Write failure and indicator events.

Parameters:
rTw Reference to TokenWriter
rLabel Section to write.
pContext Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 46 of file diag_attrfailureevents.cpp.

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

Read failure and indicator events.

Parameters:
rTr Reference to TokenReader
rLabel Section to read from.
pContext Read context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 56 of file diag_attrfailureevents.cpp.


Member Data Documentation

Set of failure events.

Definition at line 25 of file diag_attrfailureevents.h.

Set of indicator events.

Definition at line 27 of file diag_attrfailureevents.h.


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

libFAUDES 2.14g --- 2009-12-3 --- c++ source docu by doxygen 1.5.6