faudes::AttributeIosState Class Reference

Attributes for states in DESs with in- and outputs. More...

#include <ios_attributes.h>

List of all members.

Public Member Functions

 AttributeIosState (void)
 Default constructor.
 AttributeIosState (const AttributeIosState &rSrc)
 Copy constructor.
virtual ~AttributeIosState (void)
 Destructor.
void SetOutput (void)
 Set output flag.
void ClrOutput (void)
 Clear output flag.
void SetInput (void)
 Set input flag.
void ClrInput (void)
 Clear input flag.
void SetError (void)
 Set error flag.
void ClrError (void)
 Clear error flag.
bool Output (void) const
 Test output flag.
bool Input (void) const
 Test input flag.
bool Error (void) const
 Check error flag.
bool IsDefault (void) const
 Check a state's io-properties for default value.
virtual std::string ToString (void) const
 Write attribute to string.

Static Public Attributes

static const fType mInputFlag = 0x10
static const fType mOutputFlag = 0x20
static const fType mErrorFlag = 0x40

Protected Member Functions

void DoAssign (const AttributeIosState &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.
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Writes attribute to TokenWriter, see AttributeVoid for public wrappers.

Static Protected Attributes

static const fType mDefIosFlags = 0x00
static const fType mAllIosFlags = 0x70

Detailed Description

Attributes for states in DESs with in- and outputs.

The class AttributeIosState holds a bitarray to handle a state's io-properties. A state is said to be an in- or output state if the set of active events contains only in- or output events.

In order to envolve the state's io-properties during file-io the DoRead/DoWrite methods were overwritten. Use +I+ for input, +O+ for output states.

Definition at line 245 of file ios_attributes.h.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 255 of file ios_attributes.h.

faudes::AttributeIosState::AttributeIosState ( const AttributeIosState rSrc  )  [inline]

Copy constructor.

Definition at line 262 of file ios_attributes.h.

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

Destructor.

Definition at line 269 of file ios_attributes.h.


Member Function Documentation

void faudes::AttributeIosState::ClrError ( void   )  [inline]

Clear error flag.

Definition at line 326 of file ios_attributes.h.

void faudes::AttributeIosState::ClrInput ( void   )  [inline]

Clear input flag.

Note: this will clear the input flag.

Definition at line 308 of file ios_attributes.h.

void faudes::AttributeIosState::ClrOutput ( void   )  [inline]

Clear output flag.

Note: this will clear the input flag.

Definition at line 287 of file ios_attributes.h.

void faudes::AttributeIosState::DoAssign ( const AttributeIosState rSrcAttr  )  [protected]

Assignment method.

Parameters:
rSrcAttr Source to assign from

Definition at line 180 of file ios_attributes.cpp.

void faudes::AttributeIosState::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 IosStateFlag, 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.

Definition at line 248 of file ios_attributes.cpp.

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

Definition at line 193 of file ios_attributes.cpp.

void faudes::AttributeIosState::DoXWrite ( 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.

Definition at line 218 of file ios_attributes.cpp.

bool faudes::AttributeIosState::Error ( void   )  const [inline]

Check error flag.

Returns:
true: state is an error state false: state is not an error state

Definition at line 362 of file ios_attributes.h.

bool faudes::AttributeIosState::Input ( void   )  const [inline]

Test input flag.

Returns:
true: state is an input state false: state is not an input state

Definition at line 349 of file ios_attributes.h.

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

Check a state's io-properties for default value.

If a state has default properties, it's neither an input nor to output state.

Returns:
true: event has default properties false: event has non-default properties

Reimplemented from faudes::AttributeFlags.

Definition at line 376 of file ios_attributes.h.

bool faudes::AttributeIosState::Output ( void   )  const [inline]

Test output flag.

Returns:
true: state is an output state false: state is not an output state

Definition at line 337 of file ios_attributes.h.

void faudes::AttributeIosState::SetError ( void   )  [inline]

Set error flag.

Definition at line 317 of file ios_attributes.h.

void faudes::AttributeIosState::SetInput ( void   )  [inline]

Set input flag.

Note: this will clear the output flag.

Definition at line 297 of file ios_attributes.h.

void faudes::AttributeIosState::SetOutput ( void   )  [inline]

Set output flag.

Note: this will clear the input flag.

Definition at line 277 of file ios_attributes.h.

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

Write attribute to string.

Returns:
string representation of attributes

Definition at line 187 of file ios_attributes.cpp.


Member Data Documentation

const fType faudes::AttributeIosState::mAllIosFlags = 0x70 [static, protected]

Definition at line 400 of file ios_attributes.h.

const fType faudes::AttributeIosState::mDefIosFlags = 0x00 [static, protected]

Definition at line 398 of file ios_attributes.h.

Definition at line 383 of file ios_attributes.h.

Definition at line 381 of file ios_attributes.h.

Definition at line 382 of file ios_attributes.h.


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

libFAUDES 2.23h --- 2014.04.03 --- c++ api documentaion by doxygen