libFAUDES

Sections

Index

faudes::HioEventFlags Class Reference
[Hierarchical I/O Systems PlugIn]

#include <hio_attributes.h>

Inherits faudes::AttributeFlags.

List of all members.


Detailed Description

Event attributes for hierarchical discrete event systems with inputs and outputs.

These Attributes are:

  • the input/output flag U and Y.
  • the flags C, P, E and L that designate membership in one or the union of more alphabets.

Public Member Functions

 HioEventFlags (void)
 Default constructor.
virtual ~HioEventFlags (void)
virtual HioEventFlagsNew (void) const
 Construct on heap.
virtual std::string ToString (void) const
 Write attribute to string.
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

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

Constructor & Destructor Documentation

faudes::HioEventFlags::HioEventFlags ( void   )  [inline]

Default constructor.

virtual faudes::HioEventFlags::~HioEventFlags ( void   )  [inline, virtual]


Member Function Documentation

virtual HioEventFlags* faudes::HioEventFlags::New ( void   )  const [inline, virtual]

Construct on heap.

Technically not a constructor, this function creates an object with the same type. It is the callers reponsabilty to delete the object when no longer needed. Derived attribute classes must reimplement this function for container based token io to operate properly.

Returns:
Pointer to new attribute object

Reimplemented from faudes::AttributeFlags.

std::string faudes::HioEventFlags::ToString ( void   )  const [virtual]

Write attribute to string.

Returns:
string representation of attributes

void faudes::HioEventFlags::SetY ( void   )  [inline]

Set Y-flag.

void faudes::HioEventFlags::ClrY ( void   )  [inline]

Clear Y-flag.

void faudes::HioEventFlags::SetU ( void   )  [inline]

Set U-flag.

void faudes::HioEventFlags::ClrU ( void   )  [inline]

Clear U-flag.

bool faudes::HioEventFlags::IsY ( void   )  const [inline]

Query Y-flag.

bool faudes::HioEventFlags::IsU ( void   )  const [inline]

Query U-flag.

void faudes::HioEventFlags::SetP ( void   )  [inline]

Set P-flag.

void faudes::HioEventFlags::ClrP ( void   )  [inline]

Clear P-flag.

bool faudes::HioEventFlags::IsP ( void   )  const [inline]

Query P-flag.

void faudes::HioEventFlags::SetE ( void   )  [inline]

Set E-flag.

void faudes::HioEventFlags::ClrE ( void   )  [inline]

Clear E-flag.

bool faudes::HioEventFlags::IsE ( void   )  const [inline]

Query E-flag.

void faudes::HioEventFlags::SetC ( void   )  [inline]

Set C-flag.

void faudes::HioEventFlags::ClrC ( void   )  [inline]

Clear C-flag.

bool faudes::HioEventFlags::IsC ( void   )  const [inline]

Query C-flag.

void faudes::HioEventFlags::SetL ( void   )  [inline]

Set L-flag.

void faudes::HioEventFlags::ClrL ( void   )  [inline]

Clear L-flag.

bool faudes::HioEventFlags::IsL ( void   )  const [inline]

Query L-flag.

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.

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.

Parameters:
rTr TokenReader to read from
rLabel Section to read
pContext Read context to provide contextual information
Exceptions:
Exception 
  • IO error (id 1)

Reimplemented from faudes::AttributeFlags.

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.

Parameters:
rTw TokenWriter to write to
rLabel Section to write
pContext Write context to provide contextual information
Exceptions:
Exception 
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.


Member Data Documentation

const fType faudes::HioEventFlags::mUFlag = 0x04 [static]

const fType faudes::HioEventFlags::mYFlag = 0x08 [static]

const fType faudes::HioEventFlags::mPFlag = 0x10 [static]

const fType faudes::HioEventFlags::mEFlag = 0x20 [static]

const fType faudes::HioEventFlags::mCFlag = 0x40 [static]

const fType faudes::HioEventFlags::mLFlag = 0x80 [static]

const fType faudes::HioEventFlags::mDefHioEventFlags = 0x00 [static, private]

const fType faudes::HioEventFlags::mAllHioEventFlags = 0xFC [static, private]


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6