| |
libFAUDES
Sections
Index
|
faudes::HioEventFlags Class Reference |
Public Member Functions | |
virtual HioEventFlags * | New (void) const |
Construct on heap. | |
virtual HioEventFlags * | Copy (void) const |
Construct on heap. | |
virtual const HioEventFlags * | Cast (const Type *pOther) const |
Cast other object to this type. | |
virtual HioEventFlags & | Assign (const Type &rSrc) |
Assign configuration data from other object. | |
virtual bool | Equal (const Type &rOther) const |
Test equality of configuration data. | |
virtual HioEventFlags & | operator= (const HioEventFlags &rSrc) |
virtual bool | operator== (const HioEventFlags &rOther) const |
virtual bool | operator!= (const HioEventFlags &rOther) const |
HioEventFlags (void) | |
Default constructor. | |
HioEventFlags (const HioEventFlags &rSrc) | |
Copy constructor. | |
virtual | ~HioEventFlags (void) |
void | SetY (void) |
Set Y-flag. | |
void | ClrY (void) |
Clear Y-flag. | |
void | SetU (void) |
Set U-flag. | |
void | ClrU (void) |
Clear U-flag. | |
bool | IsY (void) const |
Query Y-flag. | |
bool | IsU (void) const |
Query U-flag. | |
void | SetP (void) |
Set P-flag. | |
void | ClrP (void) |
Clear P-flag. | |
bool | IsP (void) const |
Query P-flag. | |
void | SetE (void) |
Set E-flag. | |
void | ClrE (void) |
Clear E-flag. | |
bool | IsE (void) const |
Query E-flag. | |
void | SetC (void) |
Set C-flag. | |
void | ClrC (void) |
Clear C-flag. | |
bool | IsC (void) const |
Query C-flag. | |
void | SetL (void) |
Set L-flag. | |
void | ClrL (void) |
Clear L-flag. | |
bool | IsL (void) const |
Query L-flag. | |
bool | IsDefault (void) const |
Test for default value (ie input and membership in neither P-,E-,C-, nor L-alphabet). | |
Static Public Attributes | |
static const fType | mUFlag = 0x04 |
static const fType | mYFlag = 0x08 |
static const fType | mPFlag = 0x10 |
static const fType | mEFlag = 0x20 |
static const fType | mCFlag = 0x40 |
static const fType | mLFlag = 0x80 |
Protected Member Functions | |
HioEventFlags & | DoAssign (const HioEventFlags &rSrcAttr) |
Assignment method. | |
virtual void | DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0) |
Reads attribute from TokenReader, see AttributeVoid for public wrappers. | |
virtual void | DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const |
Writes attribute to TokenWriter, see AttributeVoid for public wrappers. | |
Static Private Attributes | |
static const fType | mDefHioEventFlags = 0x00 |
static const fType | mAllHioEventFlags = 0xFC |
faudes::HioEventFlags::HioEventFlags | ( | void | ) | [inline] |
faudes::HioEventFlags::HioEventFlags | ( | const HioEventFlags & | rSrc | ) | [inline] |
virtual faudes::HioEventFlags::~HioEventFlags | ( | void | ) | [inline, virtual] |
Definition at line 45 of file hio_attributes.h.
HioEventFlags * faudes::HioEventFlags::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.
Reimplemented from faudes::AttributeFlags.
Definition at line 23 of file hio_attributes.cpp.
HioEventFlags * faudes::HioEventFlags::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.
Reimplemented from faudes::AttributeFlags.
Definition at line 23 of file hio_attributes.cpp.
const HioEventFlags * faudes::HioEventFlags::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.
Reimplemented from faudes::AttributeFlags.
Definition at line 23 of file hio_attributes.cpp.
HioEventFlags & faudes::HioEventFlags::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.
rSrc | Source to copy from |
Reimplemented from faudes::AttributeFlags.
Definition at line 23 of file hio_attributes.cpp.
bool faudes::HioEventFlags::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.
rOther | Other objevt to compare with. |
Reimplemented from faudes::AttributeFlags.
Definition at line 23 of file hio_attributes.cpp.
HioEventFlags & faudes::HioEventFlags::operator= | ( | const HioEventFlags & | rSrc | ) | [virtual] |
Definition at line 23 of file hio_attributes.cpp.
bool faudes::HioEventFlags::operator== | ( | const HioEventFlags & | rOther | ) | const [virtual] |
Definition at line 23 of file hio_attributes.cpp.
bool faudes::HioEventFlags::operator!= | ( | const HioEventFlags & | rOther | ) | const [virtual] |
Definition at line 23 of file hio_attributes.cpp.
void faudes::HioEventFlags::SetY | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrY | ( | void | ) | [inline] |
void faudes::HioEventFlags::SetU | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrU | ( | void | ) | [inline] |
bool faudes::HioEventFlags::IsY | ( | void | ) | const [inline] |
bool faudes::HioEventFlags::IsU | ( | void | ) | const [inline] |
void faudes::HioEventFlags::SetP | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrP | ( | void | ) | [inline] |
bool faudes::HioEventFlags::IsP | ( | void | ) | const [inline] |
void faudes::HioEventFlags::SetE | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrE | ( | void | ) | [inline] |
bool faudes::HioEventFlags::IsE | ( | void | ) | const [inline] |
void faudes::HioEventFlags::SetC | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrC | ( | void | ) | [inline] |
bool faudes::HioEventFlags::IsC | ( | void | ) | const [inline] |
void faudes::HioEventFlags::SetL | ( | void | ) | [inline] |
void faudes::HioEventFlags::ClrL | ( | void | ) | [inline] |
bool faudes::HioEventFlags::IsL | ( | void | ) | const [inline] |
bool faudes::HioEventFlags::IsDefault | ( | void | ) | const [inline, virtual] |
Test for default value (ie input and membership in neither P-,E-,C-, nor L-alphabet).
Reimplemented from faudes::AttributeFlags.
Definition at line 158 of file hio_attributes.h.
HioEventFlags & faudes::HioEventFlags::DoAssign | ( | const HioEventFlags & | rSrcAttr | ) | [protected] |
Assignment method.
rSrcAttr | Source to assign from |
Definition at line 26 of file hio_attributes.cpp.
void faudes::HioEventFlags::DoRead | ( | TokenReader & | rTr, | |
const std::string & | rLabel = "" , |
|||
const Type * | pContext = 0 | |||
) | [protected, virtual] |
Reads attribute from TokenReader, see AttributeVoid for public wrappers.
Reads a single token if it can be interpreted as HioEventFlag, that is, if it is a respective option string or hex number. Label and Context argument are ignored. No token mismatch exceptions are thrown on error.
rTr | TokenReader to read from | |
rLabel | Section to read | |
pContext | Read context to provide contextual information |
Exception |
|
Reimplemented from faudes::AttributeFlags.
Definition at line 69 of file hio_attributes.cpp.
void faudes::HioEventFlags::DoWrite | ( | TokenWriter & | rTw, | |
const std::string & | rLabel = "" , |
|||
const Type * | pContext = 0 | |||
) | const [protected, virtual] |
Writes attribute to TokenWriter, see AttributeVoid for public wrappers.
Label and Context argument are ignored.
rTw | TokenWriter to write to | |
rLabel | Section to write | |
pContext | Write context to provide contextual information |
Exception |
|
Reimplemented from faudes::AttributeFlags.
Definition at line 34 of file hio_attributes.cpp.
const fType faudes::HioEventFlags::mUFlag = 0x04 [static] |
Definition at line 162 of file hio_attributes.h.
const fType faudes::HioEventFlags::mYFlag = 0x08 [static] |
Definition at line 163 of file hio_attributes.h.
const fType faudes::HioEventFlags::mPFlag = 0x10 [static] |
Definition at line 164 of file hio_attributes.h.
const fType faudes::HioEventFlags::mEFlag = 0x20 [static] |
Definition at line 165 of file hio_attributes.h.
const fType faudes::HioEventFlags::mCFlag = 0x40 [static] |
Definition at line 166 of file hio_attributes.h.
const fType faudes::HioEventFlags::mLFlag = 0x80 [static] |
Definition at line 167 of file hio_attributes.h.
const fType faudes::HioEventFlags::mDefHioEventFlags = 0x00 [static, private] |
Definition at line 171 of file hio_attributes.h.
const fType faudes::HioEventFlags::mAllHioEventFlags = 0xFC [static, private] |
Definition at line 174 of file hio_attributes.h.
libFAUDES 2.14g --- 2009-12-3 --- c++ source docu by doxygen 1.5.6