Detailed Description

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

Note: this is formaly derived from AttributeFlags since some some applications assume AttributeFlag the minimum attribute class.

Definition at line 23 of file diag_attrfailureevents.h.

#include <diag_attrfailureevents.h>

Public Member Functions
	AttributeFailureEvents (void)
	Default constructor. More...

	~AttributeFailureEvents (void)
	Default destructor. More...

bool	IsDefault (void) const
	Test for default values of failure and indicator events. More...

virtual void	Clear (void)
	Clears failure and indicator events. More...

Public Member Functions inherited from faudes::AttributeFlags
	AttributeFlags (void)
	Default constructor. More...

	AttributeFlags (const AttributeFlags &rOther)
	Copy constructor. More...

virtual	~AttributeFlags (void)
	Destructor. More...

bool	Test (fType mask) const
	Test a flag. More...

bool	TestAll (fType mask) const
	Test multible flags, combine by "and". More...

bool	TestSome (fType mask) const
	Test multible flags, combine by "or". More...

bool	TestNone (fType mask) const
	Test multible flags, combine by "not or". More...

void	Set (fType mask)
	Set multiple flags. More...

void	Clr (fType mask)
	Clear multiple flags. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

Public Member Functions inherited from faudes::AttributeVoid
	AttributeVoid (void)
	Constructor. More...

	AttributeVoid (const AttributeVoid &rSrcAttr)
	Copy Constructor. More...

virtual	~AttributeVoid (void)
	Destructor. More...

virtual void	SetDefault (void)
	Set to default value. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

Public Member Functions inherited from faudes::Type
	Type (void)
	Constructor. More...

	Type (const Type &rType)
	Copy constructor. More...

virtual	~Type (void)
	Destructor. More...

virtual Type *	New (void) const
	Construct on heap. More...

virtual Type *	Copy (void) const
	Construct on heap. More...

virtual const Type *	Cast (const Type *pOther) const
	Cast other object to this type. More...

virtual Type &	Assign (const Type &rSrc)
	Assign configuration data from other object. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

virtual bool	Equal (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

virtual void	Name (const std::string &rName)
	Set the objects's name. More...

virtual const std::string &	Name (void) const
	Get objects's name. More...

virtual const std::string &	TypeName (void) const
	Get objects's type name. More...

void	Write (const Type *pContext=0) const
	Write configuration data to console. More...

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
	Write configuration data to a file. More...

void	Write (const std::string &pFileName, std::ios::openmode openmode) const
	Write configuration data to a file. More...

void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to TokenWriter. More...

virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to an XML file. More...

void	XWrite (const Type *pContext=0) const
	Write configuration data in XML format to concole Note: this write function uses the virtual function DoXWrite(), to be reimplemented by derived classes. More...

void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in XML format to TokenWriter. More...

std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a string. More...

std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a formated string. More...

void	DWrite (const Type *pContext=0) const
	Write configuration data to console, debugging format. More...

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
	Write configuration data to a file, debugging format. More...

void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in debug format to TokenWriter. More...

void	SWrite (TokenWriter &rTw) const
	Write statistics comment to TokenWriter. More...

void	SWrite (void) const
	Write statistics comment to console. More...

std::string	ToSText (void) const
	Write statistics to a string. More...

void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from file with label specified. More...

void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from a string. More...

void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from TokenReader with label sepcified. More...

Public Attributes
EventSet	mFailureEvents
	Set of failure events. More...

EventSet	mIndicatorEvents
	Set of indicator events. More...

Public Attributes inherited from faudes::AttributeFlags
fType	mFlags
	Flags (public access for convenience) More...

Protected Member Functions
virtual void	DoAssign (const AttributeFailureEvents &rSrcAttr)
	Copy attribute members. More...

virtual bool	DoEuqal (const AttributeFailureEvents &rAttr) const
	Test equality. More...

void	DoWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
	Write failure and indicator events. More...

void	DoXWrite (TokenWriter &rTw, const std::string &rLabel, const Type *pContext) const
	Write failure and indicator events. More...

void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read failure and indicator events. More...

Protected Member Functions inherited from faudes::AttributeFlags
void	DoAssign (const AttributeFlags &rSrcAttr)
	Assignment method. More...

bool	DoEqual (const AttributeFlags &rOther) const
	Test equality of configuration data. More...

Protected Member Functions inherited from faudes::AttributeVoid
void	DoAssign (const AttributeVoid &rSrcAttr)
	Assign attribute members. More...

bool	DoEqual (const AttributeVoid &rOther) const
	Test equality of configuration data. More...

virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Actual write method to write the attribute to a TokenWriter. More...

Protected Member Functions inherited from faudes::Type
void	DoAssign (const Type &rSrc)
	Assign configuration data from other object. More...

bool	DoEqual (const Type &rOther) const
	Test equality of configuration data. More...

virtual void	DoSWrite (TokenWriter &rTw) const
	Write statistical data as a comment to TokenWriter. More...

virtual const TypeDefinition *	TypeDefinitionp (void) const
	Get objects's type definition. More...

virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Additional Inherited Members
Static Public Member Functions inherited from faudes::AttributeVoid
static void	Skip (TokenReader &rTr)
	Skip attribute tokens. More...

Static Public Attributes inherited from faudes::AttributeFlags
static const fType	mDefFlags =0x0

Constructor & Destructor Documentation

◆ AttributeFailureEvents()

faudes::AttributeFailureEvents::AttributeFailureEvents ( void )

Default constructor.

Definition at line 15 of file diag_attrfailureevents.cpp.

◆ ~AttributeFailureEvents()

faudes::AttributeFailureEvents::~AttributeFailureEvents ( void )

inline

Default destructor.

Definition at line 39 of file diag_attrfailureevents.h.

Member Function Documentation

◆ Clear()

void faudes::AttributeFailureEvents::Clear ( void )

virtual

Clears failure and indicator events.

Reimplemented from faudes::AttributeVoid.

Definition at line 51 of file diag_attrfailureevents.cpp.

◆ DoAssign()

void faudes::AttributeFailureEvents::DoAssign ( const AttributeFailureEvents & rSrcAttr )

protectedvirtual

Copy attribute members.

Parameters

rSrcAttr Source to copy from

Definition at line 27 of file diag_attrfailureevents.cpp.

◆ DoEuqal()

bool faudes::AttributeFailureEvents::DoEuqal ( const AttributeFailureEvents & rAttr ) const

protectedvirtual

Test equality.

Parameters

rAttr Source to copy from

Definition at line 35 of file diag_attrfailureevents.cpp.

◆ DoRead()

void faudes::AttributeFailureEvents::DoRead	(	TokenReader &	rTr,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)

protectedvirtual

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 79 of file diag_attrfailureevents.cpp.

◆ DoWrite()

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

protectedvirtual

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 57 of file diag_attrfailureevents.cpp.

◆ DoXWrite()

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

protectedvirtual

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 67 of file diag_attrfailureevents.cpp.

◆ IsDefault()

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 46 of file diag_attrfailureevents.cpp.

Member Data Documentation

◆ mFailureEvents

EventSet faudes::AttributeFailureEvents::mFailureEvents

Set of failure events.

Definition at line 29 of file diag_attrfailureevents.h.

◆ mIndicatorEvents

EventSet faudes::AttributeFailureEvents::mIndicatorEvents

Set of indicator events.

Definition at line 31 of file diag_attrfailureevents.h.

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

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AttributeFailureEvents()

◆ ~AttributeFailureEvents()

Member Function Documentation

◆ Clear()

◆ DoAssign()

◆ DoEuqal()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ IsDefault()

Member Data Documentation

◆ mFailureEvents

◆ mIndicatorEvents