faudes::AttributeCFlags Class Reference

#include <cgenerator.h>

Inheritance diagram for faudes::AttributeCFlags:

faudes::AttributeFlags faudes::AttributeVoid 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.

Definition at line 50 of file cgenerator.h.

Public Member Functions

 AttributeCFlags (void)
 Default constructor.
virtual ~AttributeCFlags (void)
 Destructor.
virtual void Read (TokenReader &rTr)
 Read attribute value from tokenreader.
virtual void Write (TokenWriter &rTw) const
 Write attribute value tokenwriter.
virtual void Write (void) const
 Write attribute value to console.
virtual std::string ToString (void) const
 Write attribute value to string.
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.
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

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.

Definition at line 55 of file cgenerator.h.

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

Destructor.

Definition at line 58 of file cgenerator.h.


Member Function Documentation

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

Clear controllable flag.

Definition at line 112 of file cgenerator.h.

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

Clear forcible flag.

Definition at line 150 of file cgenerator.h.

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

Clear observable flag.

Definition at line 131 of file cgenerator.h.

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

Query controllablility.

Definition at line 118 of file cgenerator.h.

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

Query forcibility.

Definition at line 156 of file cgenerator.h.

bool faudes::AttributeCFlags::IsDefault void   )  const [inline]
 

Test for default value.

Reimplemented from faudes::AttributeFlags.

Definition at line 162 of file cgenerator.h.

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

Query observablility.

Definition at line 137 of file cgenerator.h.

void faudes::AttributeCFlags::Read TokenReader rTr  )  [virtual]
 

Read attribute value from tokenreader.

Reads a token if it can be interpreted as AttributeCFlag. No token mismatch exceptions are thrown on error.

Parameters:
rTr TokenReader to read from
Exceptions:
Exception 
  • IO error (id 1)

Reimplemented from faudes::AttributeFlags.

Definition at line 86 of file cgenerator.cpp.

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

Set controllable flag.

Definition at line 106 of file cgenerator.h.

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

Set forcible flag.

Definition at line 144 of file cgenerator.h.

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

Set observable flag.

Definition at line 125 of file cgenerator.h.

std::string faudes::AttributeCFlags::ToString void   )  const [virtual]
 

Write attribute value to string.

Returns:
String representation of attribute value
Exceptions:
Exception 
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 78 of file cgenerator.cpp.

void faudes::AttributeCFlags::Write void   )  const [virtual]
 

Write attribute value to console.

Reimplemented from faudes::AttributeFlags.

Definition at line 70 of file cgenerator.cpp.

void faudes::AttributeCFlags::Write TokenWriter rTw  )  const [virtual]
 

Write attribute value tokenwriter.

Parameters:
rTw TokenWriter to write to
Exceptions:
Exception 
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 41 of file cgenerator.cpp.


Member Data Documentation

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

All flags used by CFlags.

Definition at line 174 of file cgenerator.h.

const fType faudes::AttributeCFlags::mControllableFlag = 0x01 [static]
 

Definition at line 165 of file cgenerator.h.

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

Overall default value.

Definition at line 171 of file cgenerator.h.

const fType faudes::AttributeCFlags::mForcibleFlag = 0x04 [static]
 

Definition at line 167 of file cgenerator.h.

const fType faudes::AttributeCFlags::mObservableFlag = 0x02 [static]
 

Definition at line 166 of file cgenerator.h.


The documentation for this class was generated from the following files:
Generated on Fri May 9 11:26:48 2008 for libFAUDES 2.09b by  doxygen 1.4.4