libFAUDES

Sections

Index

faudes::AttributeCFlags Class Reference

#include <cgenerator.h>

Inherits faudes::AttributeFlags.

Inherited by faudes::SimEventAttribute.

List of all members.


Detailed Description

Attribute class to model event controllability properties.

This attribute is meant to be an event attribute and can distinguish between controllable, observable and forcible events. It is based on faudes::AttributeFlags and uses the lower three bits in the flag word to store the respective boolean values. The AttributeCFlags class adds convenience functions to access these bits and a default-value that corresponds to observable and neiter controllable nor forcible.

Presuming that only controllability flags are uses (different from default), the token representation is by an Option String consisting of the initials c,o and f, where initials are capitatised for set flags and default values are not writtem; eg +C+ for a controllable event tzhat is observable (default) and not forcible (default). If other than the three controllability bits are used, std. hex format is used.

Public Member Functions

virtual AttributeCFlagsNew (void) const
 Construct on heap.
virtual const AttributeCFlagsCast (const Type *pOther) const
 Cast other object to this type.
 AttributeCFlags (void)
 Default constructor.
virtual ~AttributeCFlags (void)
 Destructor.
void SetControllable (void)
 Set controllable flag.
void ClrControllable (void)
 Clear controllable flag.
bool Controllable (void) const
 Query controllablility.
void SetObservable (void)
 Set observable flag.
void ClrObservable (void)
 Clear observable flag.
bool Observable (void) const
 Query observablility.
void SetForcible (void)
 Set forcible flag.
void ClrForcible (void)
 Clear forcible flag.
bool Forcible (void) const
 Query forcibility.
virtual bool IsDefault (void) const
 Test for default value.

Static Public Attributes

static const fType mControllableFlag = 0x01
static const fType mObservableFlag = 0x02
static const fType mForcibleFlag = 0x04

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 mDefCFlags = 0x02
 Overall default value.
static const fType mAllCFlags = 0x07
 All flags used by CFlags.


Constructor & Destructor Documentation

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

Default constructor.

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

Destructor.


Member Function Documentation

AttributeCFlags * faudes::AttributeCFlags::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.

Returns:
Pointer to new Type object

Reimplemented from faudes::AttributeFlags.

Reimplemented in faudes::SimEventAttribute.

const AttributeCFlags * faudes::AttributeCFlags::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.

Returns:
Typed pointer object

Reimplemented from faudes::AttributeFlags.

void faudes::AttributeCFlags::SetControllable ( void   )  [inline]

Set controllable flag.

void faudes::AttributeCFlags::ClrControllable ( void   )  [inline]

Clear controllable flag.

bool faudes::AttributeCFlags::Controllable ( void   )  const [inline]

Query controllablility.

void faudes::AttributeCFlags::SetObservable ( void   )  [inline]

Set observable flag.

void faudes::AttributeCFlags::ClrObservable ( void   )  [inline]

Clear observable flag.

bool faudes::AttributeCFlags::Observable ( void   )  const [inline]

Query observablility.

void faudes::AttributeCFlags::SetForcible ( void   )  [inline]

Set forcible flag.

void faudes::AttributeCFlags::ClrForcible ( void   )  [inline]

Clear forcible flag.

bool faudes::AttributeCFlags::Forcible ( void   )  const [inline]

Query forcibility.

virtual bool faudes::AttributeCFlags::IsDefault ( void   )  const [inline, virtual]

Test for default value.

Reimplemented from faudes::AttributeFlags.

Reimplemented in faudes::SimEventAttribute.

void faudes::AttributeCFlags::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 AttributeCFlag, 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.

Reimplemented in faudes::SimEventAttribute.

void faudes::AttributeCFlags::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.

Reimplemented in faudes::SimEventAttribute.


Member Data Documentation

const fType faudes::AttributeCFlags::mDefCFlags = 0x02 [static, private]

Overall default value.

const fType faudes::AttributeCFlags::mAllCFlags = 0x07 [static, private]

All flags used by CFlags.


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

libFAUDES 2.13a c++ source docu by doxygen 1.5.6