faudes::AttributeIosEvent Class Reference

Attributes for events in DES with in- and outputs. More...

#include <ios_attributes.h>

List of all members.

Public Member Functions

 AttributeIosEvent (void)
 Default constructor.
 AttributeIosEvent (const AttributeIosEvent &rSrc)
 Copy constructor.
virtual ~AttributeIosEvent (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.
bool Output (void) const
 Test output flag.
bool Input (void) const
 Test input flag.
bool IsDefault (void) const
 Check an event's io-properties for default value.

Protected Member Functions

void DoAssign (const AttributeIosEvent &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 mInputFlag = 0x010
static const fType mOutputFlag = 0x020
static const fType mDefIosFlags = 0x000
static const fType mAllIosFlags = 0x030

Detailed Description

Attributes for events in DES with in- and outputs.

The class AttributeIosEvent holds a bitarray to handle an event's io-properties

In order to envolve the event's io-properties during file-io the DoRead/DoWrite methods were overwritten. Use Attributes +I+ and +O+ in .gen file to make sure an event will be inserted in Iput or OTput event set.

Definition at line 39 of file ios_attributes.h.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 49 of file ios_attributes.h.

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

Copy constructor.

Definition at line 56 of file ios_attributes.h.

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

Destructor.

Definition at line 63 of file ios_attributes.h.


Member Function Documentation

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

Clear input flag.

Note: this will clear the input flag.

Definition at line 103 of file ios_attributes.h.

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

Clear output flag.

Note: this will clear the input flag.

Definition at line 82 of file ios_attributes.h.

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

Assignment method.

Parameters:
rSrcAttr Source to assign from

Definition at line 36 of file ios_attributes.cpp.

void faudes::AttributeIosEvent::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 IosEventFlag, 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 103 of file ios_attributes.cpp.

void faudes::AttributeIosEvent::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 43 of file ios_attributes.cpp.

void faudes::AttributeIosEvent::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 77 of file ios_attributes.cpp.

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

Test input flag.

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

Definition at line 126 of file ios_attributes.h.

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

Check an event's io-properties for default value.

If an event has default properties, it's wether an input nor to output event.

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

Reimplemented from faudes::AttributeFlags.

Definition at line 142 of file ios_attributes.h.

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

Test output flag.

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

Definition at line 114 of file ios_attributes.h.

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

Set input flag.

Note: this will clear the output flag.

Definition at line 92 of file ios_attributes.h.

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

Set output flag.

Note: this will clear the input flag.

Definition at line 72 of file ios_attributes.h.


Member Data Documentation

const fType faudes::AttributeIosEvent::mAllIosFlags = 0x030 [static, protected]

Definition at line 156 of file ios_attributes.h.

const fType faudes::AttributeIosEvent::mDefIosFlags = 0x000 [static, protected]

Definition at line 153 of file ios_attributes.h.

const fType faudes::AttributeIosEvent::mInputFlag = 0x010 [static, protected]

Definition at line 149 of file ios_attributes.h.

const fType faudes::AttributeIosEvent::mOutputFlag = 0x020 [static, protected]

Definition at line 150 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