faudes::AttributeVoid Class Reference

#include <attributes.h>

Inheritance diagram for faudes::AttributeVoid:

faudes::AttributeFlags faudes::AttributeCFlags List of all members.

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.

Definition at line 41 of file attributes.h.

Public Member Functions

 AttributeVoid (void)
 Constructor.
virtual ~AttributeVoid (void)
 Destructor.
virtual void Read (TokenReader &rTr)
 Read attribute value from tokenreader.
virtual void Write (TokenWriter &rTw) const
 Write attribute value tokenreader.
virtual void Write (void) const
 Write attribute value to console.
virtual std::string ToString (void) const
 Write attribute to string.
bool IsDefault (void) const
 Test for default value.


Constructor & Destructor Documentation

faudes::AttributeVoid::AttributeVoid void   )  [inline]
 

Constructor.

Definition at line 45 of file attributes.h.

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

Destructor.

Definition at line 48 of file attributes.h.


Member Function Documentation

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

Test for default value.

Reimplemented in faudes::AttributeFlags, and faudes::AttributeCFlags.

Definition at line 97 of file attributes.h.

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

Read attribute value from tokenreader.

This function skips all tokens until a String or Integer token indicates the end of all attribute values. For derived classes, the read function shall shall try to read the attribute value and than call AttributeVoid::Read() to flush unknown tokens that presumably represent unsupported attributes. This function shall not throw token mismatch exceptions.

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

Reimplemented in faudes::AttributeFlags, and faudes::AttributeCFlags.

Definition at line 39 of file attributes.cpp.

virtual std::string faudes::AttributeVoid::ToString void   )  const [inline, virtual]
 

Write attribute to string.

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

Reimplemented in faudes::AttributeFlags, and faudes::AttributeCFlags.

Definition at line 92 of file attributes.h.

virtual void faudes::AttributeVoid::Write void   )  const [inline, virtual]
 

Write attribute value to console.

Reimplemented in faudes::AttributeFlags, and faudes::AttributeCFlags.

Definition at line 81 of file attributes.h.

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

Write attribute value tokenreader.

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

Reimplemented in faudes::AttributeFlags, and faudes::AttributeCFlags.

Definition at line 35 of file attributes.cpp.


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