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

Partitions the failure and indicator events. More...

#include <diag_attrfailuretypes.h>

List of all members.

Public Member Functions
	AttributeFailureTypeMap (void)
	Default constructor.
	AttributeFailureTypeMap (const std::string &rFilename)
	Constructor from file.
	AttributeFailureTypeMap (const AttributeFailureTypeMap &rOtherAttr)
	Copyconstructor.
	~AttributeFailureTypeMap (void)
	Destructor.
bool	IsDefault (void) const
	Test for default value.
bool	Empty (void) const
	Test if mFailureTypeMap is empty.
void	Clear (void)
	Clears mFailureTypeMap.
Idx	AddFailureTypeMapping (const std::string &failureType, const EventSet &rfailureEvents)
	Add a set of failure events to failure type map.
void	AddFailureTypeMap (const std::map< std::string, EventSet > &rFailureMap)
	Inserts entire failure type map to mFailureTypeMap.
Idx	FailureType (Idx failureEvent) const
	Returns failure type of failure event.
EventSet	AllFailureEvents (void) const
	Obtain all failure events in mFailureTypeMap.
Public Attributes
TaNameSet< AttributeFailureEvents >	mFailureTypeMap
	Failure and indicator event partition.
Protected Member Functions
void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write mFailureTypeMap to TokenWriter.
void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write mFailureTypeMap to TokenWriter.
void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read mFailureTypeMap from TokenReader.
void	DoAssign (const AttributeFailureTypeMap &rSrcAttr)
	Copy attribute members.
bool	DoEqual (const AttributeFailureTypeMap &rAttr) const
	Test equality.

---

Detailed Description

Partitions the failure and indicator events.

This attribute is a wrapper to a nameset with failuretype attributes.

Note: formally derived from AttributeFlags for strategic reasons only

Definition at line 25 of file diag_attrfailuretypes.h.

---

Constructor & Destructor Documentation

faudes::AttributeFailureTypeMap::AttributeFailureTypeMap

(

void

)

Default constructor.

Definition at line 15 of file diag_attrfailuretypes.cpp.

faudes::AttributeFailureTypeMap::AttributeFailureTypeMap

(

const std::string &

rFilename

)

Constructor from file.

Definition at line 26 of file diag_attrfailuretypes.cpp.

faudes::AttributeFailureTypeMap::AttributeFailureTypeMap

(

const AttributeFailureTypeMap &

rOtherAttr

)

Copyconstructor.

Definition at line 39 of file diag_attrfailuretypes.cpp.

faudes::AttributeFailureTypeMap::~AttributeFailureTypeMap

(

void

)

[inline]

Destructor.

Definition at line 48 of file diag_attrfailuretypes.h.

---

Member Function Documentation

void faudes::AttributeFailureTypeMap::AddFailureTypeMap

(

const std::map< std::string, EventSet > &

rFailureMap

)

Inserts entire failure type map to mFailureTypeMap.

Parameters:

rFailureMap

Mapping of failure type names to failure events

Definition at line 110 of file diag_attrfailuretypes.cpp.

Idx faudes::AttributeFailureTypeMap::AddFailureTypeMapping	(	const std::string &	failureType,
		const EventSet &	rfailureEvents
	)

Add a set of failure events to failure type map.

Make sure that you do not insert a failure event which is part of another failure type as well!

Parameters:

	failureType	Name of failure type
	rfailureEvents	Associated failure events

Returns:

Index of entry for failure type name in LabelSymbolTable.

Exceptions:

Exception

Adding failure to LabelSymbolTable failed (id 300).

Definition at line 85 of file diag_attrfailuretypes.cpp.

EventSet faudes::AttributeFailureTypeMap::AllFailureEvents

(

void

)

const

Obtain all failure events in mFailureTypeMap.

Returns:

EventSet containing all failure events.

Definition at line 132 of file diag_attrfailuretypes.cpp.

void faudes::AttributeFailureTypeMap::Clear

(

void

)

[virtual]

Clears mFailureTypeMap.

Reimplemented from faudes::AttributeVoid.

Definition at line 80 of file diag_attrfailuretypes.cpp.

void faudes::AttributeFailureTypeMap::DoAssign

(

const AttributeFailureTypeMap &

rSrcAttr

)

[protected]

Copy attribute members.

Parameters:

rSrcAttr

Source to copy from

Definition at line 53 of file diag_attrfailuretypes.cpp.

bool faudes::AttributeFailureTypeMap::DoEqual

(

const AttributeFailureTypeMap &

rAttr

)

const [protected]

Test equality.

Parameters:

rAttr

Other attribute to compare with

Definition at line 59 of file diag_attrfailuretypes.cpp.

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

Read mFailureTypeMap from TokenReader.

Parameters:

	rTr	Reference to TokenReader
	rLabel	Is ignored. Failure events are read from section "FailureEvents" and indicator events from section "IndicatorEvents".
	pContext	Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 158 of file diag_attrfailuretypes.cpp.

void faudes::AttributeFailureTypeMap::DoWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = "",
		const Type *	pContext = 0
	)			const [protected, virtual]

Write mFailureTypeMap to TokenWriter.

Parameters:

	rTw	Reference to TokenWriter
	rLabel	Is ignored. Failure events are written in a section "FailureEvents" and indicator events in a separate section "IndicatorEvents".
	pContext	Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 146 of file diag_attrfailuretypes.cpp.

void faudes::AttributeFailureTypeMap::DoXWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = "",
		const Type *	pContext = 0
	)			const [protected, virtual]

Write mFailureTypeMap to TokenWriter.

Parameters:

	rTw	Reference to TokenWriter
	rLabel	Is ignored. Failure events are written in a section "FailureEvents" and indicator events in a separate section "IndicatorEvents".
	pContext	Write context to provide contextual information

Reimplemented from faudes::AttributeFlags.

Definition at line 152 of file diag_attrfailuretypes.cpp.

bool faudes::AttributeFailureTypeMap::Empty

(

void

)

const

Test if mFailureTypeMap is empty.

Returns:

True if empty

Definition at line 75 of file diag_attrfailuretypes.cpp.

Idx faudes::AttributeFailureTypeMap::FailureType

(

Idx

failureEvent

)

const

Returns failure type of failure event.

Parameters:

failureEvent

Index of failure event.

Returns:

Index of failure type.

Definition at line 120 of file diag_attrfailuretypes.cpp.

bool faudes::AttributeFailureTypeMap::IsDefault

(

void

)

const [virtual]

Test for default value.

Returns:

True for default value

Reimplemented from faudes::AttributeFlags.

Definition at line 70 of file diag_attrfailuretypes.cpp.

---

Member Data Documentation

TaNameSet<AttributeFailureEvents> faudes::AttributeFailureTypeMap::mFailureTypeMap

Failure and indicator event partition.

Mapping of failure type indices (as defined in GlobalEventSymbolTable) to associated failure events and indicator events.

Definition at line 36 of file diag_attrfailuretypes.h.

---

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

• diag_attrfailuretypes.h
• diag_attrfailuretypes.cpp