faudes::AttributeVoid Class Reference

Minimal Attribute. More...

#include <cfl_attributes.h>

List of all members.

Public Member Functions

 AttributeVoid (void)
 Constructor.
virtual ~AttributeVoid (void)
 Destructor.
virtual bool IsDefault (void) const
 Test for default value.
virtual void SetDefault (void)
 Set to default value.
virtual void Clear (void)
 Synonym for SetDefault to match std interface.

Static Public Member Functions

static void Skip (TokenReader &rTr)
 Skip attribute tokens.

Protected Member Functions

virtual void DoAssign (const AttributeVoid &rSrcAttr)
 Assign attribute members.
virtual bool DoEqual (const AttributeVoid &rOther) const
 Test equality of configuration data.
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 Actual read method to read attribute from tokenreader.
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 Actual write method to write the attribute to a TokenWriter.

Detailed Description

Minimal Attribute.

Attributes are used as template parameters for faudes containers and generators and facilitate the modelling of customized properties of events, states and transitions. The AttributeVoid class defines the minimal interface of faudes attributes and therefore is the designated base class for all attribute implementations. The AttributeVoid class does not define any actual properties. See AttributeFlags for a non-trivial example.

To derive a class from AttributeVoid you should reimplement the virtual interface

Definition at line 52 of file cfl_attributes.h.


Constructor & Destructor Documentation

faudes::AttributeVoid::AttributeVoid ( void   ) 

Constructor.

Definition at line 38 of file cfl_attributes.cpp.

faudes::AttributeVoid::~AttributeVoid ( void   )  [virtual]

Destructor.

Definition at line 43 of file cfl_attributes.cpp.


Member Function Documentation

virtual void faudes::AttributeVoid::DoAssign ( const AttributeVoid rSrcAttr  )  [inline, protected, virtual]

Assign attribute members.

Since AttributeVoid has no members, this method does nothing. Derived classes are meant to reimplement DoAssign by first calling their base and then assigning additional member variables.

Parameters:
rSrcAttr Source to assign from

Definition at line 105 of file cfl_attributes.h.

virtual bool faudes::AttributeVoid::DoEqual ( const AttributeVoid rOther  )  const [inline, protected, virtual]

Test equality of configuration data.

Derived attributes should reimplement this class to compare configuration data. The base AttributeVoid returns true as a default.

Parameters:
rOther Other object to compare with.
Returns:
True on match.

Definition at line 116 of file cfl_attributes.h.

void faudes::AttributeVoid::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
) [protected, virtual]

Actual read method to read attribute from tokenreader.

For derived attributue classes, this method must either read all tokens that belong to the respective attribute, or none. It may throw exceptions on token mismatch within the relevant attribute, but it may not throw exceptions when it encounters tokens that possibly belong to another attribute. The latter are to be skipped by the provided Skip method. See Type::Read for public wrappers.

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::Type.

Reimplemented in faudes::AttributeFlags, faudes::AttributeCFlags, faudes::AttributeDiagnoserState, faudes::AttributeFailureEvents, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::HioEventFlags, faudes::HioStateFlags, faudes::AttributeIosEvent, faudes::AttributeIosState, faudes::AttributeColoredState, faudes::AttributePushdownState, faudes::AttributePushdownTransition, faudes::AttributePushdownGlobal, faudes::AttributeGotoTransition, faudes::AttributeGotoState, faudes::AttributeTimedTrans, faudes::AttributeTimedState, faudes::AttributeTimedGlobal, faudes::AttributeSimCondition, faudes::SimEventAttribute, faudes::AttributeSignalOutput, faudes::AttributeSignalInput, faudes::AttributeSimplenetOutput, faudes::AttributeSimplenetInput, and faudes::AttributeDeviceEvent.

Definition at line 54 of file cfl_attributes.cpp.

void faudes::AttributeVoid::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const [protected, virtual]
virtual void faudes::AttributeVoid::SetDefault ( void   )  [inline, virtual]

Set to default value.

Derived classes must reimplement this function for Clear to operate properly.

Definition at line 73 of file cfl_attributes.h.

void faudes::AttributeVoid::Skip ( TokenReader rTr  )  [static]

Skip attribute tokens.

Helper method to be called after all sttribute derived classes had their chance to read their data. It skips all tokens and sections until it reaches a String or decimal Integer.

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

Definition at line 60 of file cfl_attributes.cpp.


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

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