About
User Reference
C++ API
luafaudes
Developer
Links
libFAUDES online
libFAUDES
C++ API
Sections
Sets
Generators
Functions
PlugIns
Tutorials
Index
Classes
Files
diag_attrfailureevents.h
Go to the documentation of this file.
1
/** @file diag_attrfailureevents.h Failure and indicator events for a common failure type. */
2
3
#ifndef DIAG_ATTRFAILUREEVENTS_H
4
#define DIAG_ATTRFAILUREEVENTS_H
5
6
#include <vector>
7
#include <map>
8
#include <set>
9
#include "
corefaudes.h
"
10
#include "
diag_attrlabelset.h
"
11
#include "
diag_debug.h
"
12
13
namespace
faudes {
14
15
/**
16
* Stores the failure and indicator events for a particular failure type.
17
*
18
* Note: this is formaly derived from AttributeFlags since some
19
* some applications assume AttributeFlag the minimum attribute class.
20
*
21
* @ingroup DiagnosisPlugIn
22
*/
23
class
AttributeFailureEvents
:
public
AttributeFlags
{
24
25
FAUDES_TYPE_DECLARATION
(Void,
AttributeFailureEvents
,
AttributeFlags
)
26
27
public
:
28
/** Set of failure events. */
29
EventSet
mFailureEvents
;
30
/** Set of indicator events. */
31
EventSet
mIndicatorEvents
;
32
33
public
:
34
35
/** Default constructor. */
36
AttributeFailureEvents
(
void
);
37
38
/** Default destructor. */
39
~AttributeFailureEvents
(
void
) {};
40
41
/**
42
* Test for default values of failure and indicator events.
43
*
44
* @return
45
* True for default value.
46
*/
47
bool
IsDefault
(
void
)
const
;
48
49
/**
50
* Clears failure and indicator events.
51
*/
52
virtual
void
Clear
(
void
);
53
54
protected
:
55
56
/**
57
* Copy attribute members
58
*
59
* @param rSrcAttr
60
* Source to copy from
61
*/
62
virtual
void
DoAssign
(
const
AttributeFailureEvents
& rSrcAttr);
63
64
/**
65
* Test equality
66
*
67
* @param rAttr
68
* Source to copy from
69
*/
70
virtual
bool
DoEuqal
(
const
AttributeFailureEvents
& rAttr)
const
;
71
72
/**
73
* Write failure and indicator events.
74
*
75
* @param rTw
76
* Reference to TokenWriter
77
* @param rLabel
78
* Section to write.
79
* @param pContext
80
* Write context to provide contextual information
81
*/
82
void
DoWrite
(
TokenWriter
& rTw,
const
std::string& rLabel,
const
Type
* pContext)
const
;
83
84
/**
85
* Write failure and indicator events.
86
*
87
* @param rTw
88
* Reference to TokenWriter
89
* @param rLabel
90
* Section to write.
91
* @param pContext
92
* Write context to provide contextual information
93
*/
94
void
DoXWrite
(
TokenWriter
& rTw,
const
std::string& rLabel,
const
Type
* pContext)
const
;
95
96
/**
97
* Read failure and indicator events.
98
*
99
* @param rTr
100
* Reference to TokenReader
101
* @param rLabel
102
* Section to read from.
103
* @param pContext
104
* Read context to provide contextual information
105
*/
106
void
DoRead
(
TokenReader
&rTr,
const
std::string &rLabel=
""
,
const
Type
*pContext=0);
107
108
};
// class AttributeFailureEvents
109
110
111
}
// namespace faudes
112
113
#endif
libFAUDES 2.24g
--- 2014.09.15 --- c++ api documentaion by
doxygen
>>
C++ API
Introduction
Sets
Generators
Functions
PlugIns
Tutorials
Classes
Files
Top of Page