| |
libFAUDES
Sections
Index
|
faudes::HioStateFlags Class Reference |
Public Member Functions | |
virtual HioStateFlags * | New (void) const |
Construct on heap. | |
virtual HioStateFlags * | Copy (void) const |
Construct on heap. | |
virtual const HioStateFlags * | Cast (const Type *pOther) const |
Cast other object to this type. | |
virtual HioStateFlags & | Assign (const Type &rSrc) |
Assign configuration data from other object. | |
virtual bool | Equal (const Type &rOther) const |
Test equality of configuration data. | |
virtual HioStateFlags & | operator= (const HioStateFlags &rSrc) |
virtual bool | operator== (const HioStateFlags &rOther) const |
virtual bool | operator!= (const HioStateFlags &rOther) const |
HioStateFlags (void) | |
Default constructor. | |
HioStateFlags (const HioStateFlags &rSrc) | |
Copy constructor. | |
virtual | ~HioStateFlags (void) |
virtual std::string | ToString (void) const |
Write attribute to string. | |
void | SetQY (void) |
Set QY-state flag. | |
void | ClrQY (void) |
Clear QY-state flag. | |
bool | IsQY (void) const |
Query QY-state flag. | |
void | SetQU (void) |
Set QU-state flag. | |
void | ClrQU (void) |
Clear QU-state flag. | |
bool | IsQU (void) const |
Query QU-state flag. | |
void | SetQC (void) |
Set QC-state flag. | |
void | ClrQC (void) |
Clear QC-state flag. | |
bool | IsQC (void) const |
Query QC-state flag. | |
void | SetQP (void) |
Set QP-state flag. | |
void | ClrQP (void) |
Clear QP-state flag. | |
bool | IsQP (void) const |
Query QP-state flag. | |
void | SetQE (void) |
Set QE-state flag. | |
void | ClrQE (void) |
Clear QE-state flag. | |
bool | IsQE (void) const |
Query QE-state flag. | |
void | SetQL (void) |
Set QL-state flag. | |
void | ClrQL (void) |
Clear QL-state flag. | |
bool | IsQL (void) const |
Query QL-state flag. | |
void | SetQYcUp (void) |
Set QYcUp-state flag. | |
void | ClrQYcUp (void) |
Clear QYcUp-state flag. | |
bool | IsQYcUp (void) const |
Query QYcUp-state flag. | |
void | SetQYlUe (void) |
Set QYlUe-state flag. | |
void | ClrQYlUe (void) |
Clear QYlUe-state flag. | |
bool | IsQYlUe (void) const |
Query QYlUe-state flag. | |
void | SetErr (void) |
Set Err-state flag. | |
void | ClrErr (void) |
Clear Err-state flag. | |
bool | IsErr (void) const |
Query Err-state flag. | |
bool | IsDefault (void) const |
Test for default value. | |
Static Public Attributes | |
static const fType | mQYFlag = 0x01 |
static const fType | mQUFlag = 0x02 |
static const fType | mQCFlag = 0x04 |
static const fType | mQPFlag = 0x08 |
static const fType | mQEFlag = 0x10 |
static const fType | mQLFlag = 0x20 |
static const fType | mQYcUpFlag = 0x40 |
static const fType | mQYlUeFlag = 0x80 |
static const fType | mErrFlag = 0x100 |
Protected Member Functions | |
HioStateFlags & | DoAssign (const HioStateFlags &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 | mDefHioStateFlags = 0x000 |
static const fType | mAllHioStateFlags = 0x1FF |
faudes::HioStateFlags::HioStateFlags | ( | void | ) | [inline] |
faudes::HioStateFlags::HioStateFlags | ( | const HioStateFlags & | rSrc | ) | [inline] |
virtual faudes::HioStateFlags::~HioStateFlags | ( | void | ) | [inline, virtual] |
Definition at line 271 of file hio_attributes.h.
HioStateFlags * faudes::HioStateFlags::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 102 of file hio_attributes.cpp.
HioStateFlags * faudes::HioStateFlags::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 102 of file hio_attributes.cpp.
const HioStateFlags * faudes::HioStateFlags::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 102 of file hio_attributes.cpp.
HioStateFlags & faudes::HioStateFlags::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 102 of file hio_attributes.cpp.
bool faudes::HioStateFlags::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 102 of file hio_attributes.cpp.
HioStateFlags & faudes::HioStateFlags::operator= | ( | const HioStateFlags & | rSrc | ) | [virtual] |
Definition at line 102 of file hio_attributes.cpp.
bool faudes::HioStateFlags::operator== | ( | const HioStateFlags & | rOther | ) | const [virtual] |
Definition at line 102 of file hio_attributes.cpp.
bool faudes::HioStateFlags::operator!= | ( | const HioStateFlags & | rOther | ) | const [virtual] |
Definition at line 102 of file hio_attributes.cpp.
std::string faudes::HioStateFlags::ToString | ( | void | ) | const [virtual] |
Write attribute to string.
Definition at line 152 of file hio_attributes.cpp.
void faudes::HioStateFlags::SetQY | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQY | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQY | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQU | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQU | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQU | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQC | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQC | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQC | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQP | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQP | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQP | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQE | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQE | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQE | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQL | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQL | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQL | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQYcUp | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQYcUp | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQYcUp | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetQYlUe | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrQYlUe | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsQYlUe | ( | void | ) | const [inline] |
void faudes::HioStateFlags::SetErr | ( | void | ) | [inline] |
void faudes::HioStateFlags::ClrErr | ( | void | ) | [inline] |
bool faudes::HioStateFlags::IsErr | ( | void | ) | const [inline] |
bool faudes::HioStateFlags::IsDefault | ( | void | ) | const [inline, virtual] |
Test for default value.
Reimplemented from faudes::AttributeFlags.
Definition at line 468 of file hio_attributes.h.
HioStateFlags & faudes::HioStateFlags::DoAssign | ( | const HioStateFlags & | rSrcAttr | ) | [protected] |
Assignment method.
rSrcAttr | Source to assign from |
Definition at line 105 of file hio_attributes.cpp.
void faudes::HioStateFlags::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 HioStateFlag, 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 157 of file hio_attributes.cpp.
void faudes::HioStateFlags::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 113 of file hio_attributes.cpp.
const fType faudes::HioStateFlags::mQYFlag = 0x01 [static] |
Definition at line 472 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQUFlag = 0x02 [static] |
Definition at line 473 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQCFlag = 0x04 [static] |
Definition at line 474 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQPFlag = 0x08 [static] |
Definition at line 475 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQEFlag = 0x10 [static] |
Definition at line 476 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQLFlag = 0x20 [static] |
Definition at line 477 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQYcUpFlag = 0x40 [static] |
Definition at line 478 of file hio_attributes.h.
const fType faudes::HioStateFlags::mQYlUeFlag = 0x80 [static] |
Definition at line 479 of file hio_attributes.h.
const fType faudes::HioStateFlags::mErrFlag = 0x100 [static] |
Definition at line 480 of file hio_attributes.h.
const fType faudes::HioStateFlags::mDefHioStateFlags = 0x000 [static, private] |
Definition at line 484 of file hio_attributes.h.
const fType faudes::HioStateFlags::mAllHioStateFlags = 0x1FF [static, private] |
Definition at line 487 of file hio_attributes.h.
libFAUDES 2.14g --- 2009-12-3 --- c++ source docu by doxygen 1.5.6