#include <ios_attributes.h>

Public Member Functions

 AttributeIosState (void)
 
 AttributeIosState (const AttributeIosState &rSrc)
 
virtual ~AttributeIosState (void)
 
void SetOutput (void)
 
void ClrOutput (void)
 
void SetInput (void)
 
void ClrInput (void)
 
void SetError (void)
 
void ClrError (void)
 
bool Output (void) const
 
bool Input (void) const
 
bool Error (void) const
 
bool IsDefault (void) const
 
virtual std::string ToString (void) const
 
- Public Member Functions inherited from faudes::AttributeFlags
 AttributeFlags (void)
 
 AttributeFlags (const AttributeFlags &rOther)
 
virtual ~AttributeFlags (void)
 
bool Test (fType mask) const
 
bool TestAll (fType mask) const
 
bool TestSome (fType mask) const
 
bool TestNone (fType mask) const
 
void Set (fType mask)
 
void Clr (fType mask)
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 
 AttributeVoid (const AttributeVoid &rSrcAttr)
 
virtual ~AttributeVoid (void)
 
virtual void SetDefault (void)
 
virtual void Clear (void)
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
- Public Member Functions inherited from faudes::Type
 Type (void)
 
 Type (const Type &rType)
 
virtual ~Type (void)
 
virtual TypeNew (void) const
 
virtual TypeCopy (void) const
 
virtual const TypeCast (const Type *pOther) const
 
virtual TypeAssign (const Type &rSrc)
 
Typeoperator= (const Type &rSrc)
 
virtual bool Equal (const Type &rOther) const
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) const
 
virtual void Name (const std::string &rName)
 
virtual const std::string & Name (void) const
 
virtual const std::string & TypeName (void) const
 
void Write (const Type *pContext=0) const
 
void Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void Write (const std::string &pFileName, std::ios::openmode openmode) const
 
void Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
virtual void XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
 
void XWrite (const Type *pContext=0) const
 
void XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToString (const std::string &rLabel="", const Type *pContext=0) const
 
std::string ToText (const std::string &rLabel="", const Type *pContext=0) const
 
void DWrite (const Type *pContext=0) const
 
void DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
 
void DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
void SWrite (TokenWriter &rTw) const
 
void SWrite (void) const
 
std::string ToSText (void) const
 
void Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
 
void FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
 
void Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 

Static Public Attributes

static const fType mInputFlag = 0x10
 
static const fType mOutputFlag = 0x20
 
static const fType mErrorFlag = 0x40
 
- Static Public Attributes inherited from faudes::AttributeFlags
static const fType mDefFlags =0x0
 

Protected Member Functions

void DoAssign (const AttributeIosState &rSrcAttr)
 
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
 
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
- Protected Member Functions inherited from faudes::AttributeFlags
void DoAssign (const AttributeFlags &rSrcAttr)
 
bool DoEqual (const AttributeFlags &rOther) const
 
- Protected Member Functions inherited from faudes::AttributeVoid
void DoAssign (const AttributeVoid &rSrcAttr)
 
bool DoEqual (const AttributeVoid &rOther) const
 
virtual void DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
 
- Protected Member Functions inherited from faudes::Type
void DoAssign (const Type &rSrc)
 
bool DoEqual (const Type &rOther) const
 
virtual void DoSWrite (TokenWriter &rTw) const
 
virtual const TypeDefinitionTypeDefinitionp (void) const
 
virtual Token XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const
 

Static Protected Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from faudes::AttributeVoid
static void Skip (TokenReader &rTr)
 
- Public Attributes inherited from faudes::AttributeFlags
fType mFlags
 

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

◆ AttributeIosState() [1/2]

faudes::AttributeIosState::AttributeIosState ( void  )
inline

Default constructor

Definition at line 255 of file ios_attributes.h.

◆ AttributeIosState() [2/2]

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

Copy constructor

Definition at line 262 of file ios_attributes.h.

◆ ~AttributeIosState()

virtual faudes::AttributeIosState::~AttributeIosState ( void  )
inlinevirtual

Destructor

Definition at line 269 of file ios_attributes.h.

Member Function Documentation

◆ ClrError()

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

Clear error flag

Definition at line 326 of file ios_attributes.h.

◆ ClrInput()

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.

◆ ClrOutput()

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.

◆ DoAssign()

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

Assignment method.

Parameters
rSrcAttrSource to assign from

Definition at line 180 of file ios_attributes.cpp.

◆ DoRead()

void faudes::AttributeIosState::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = 0 
)
protectedvirtual

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
rTrTokenReader to read from
rLabelSection to read
pContextRead context to provide contextual information
Exceptions
Exception
  • IO error (id 1)

Reimplemented from faudes::AttributeFlags.

Definition at line 248 of file ios_attributes.cpp.

◆ DoWrite()

void faudes::AttributeIosState::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const
protectedvirtual

Writes attribute to TokenWriter, see AttributeVoid for public wrappers. Label and Context argument are ignored.

Parameters
rTwTokenWriter to write to
rLabelSection to write
pContextWrite context to provide contextual information
Exceptions
Exception
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 193 of file ios_attributes.cpp.

◆ DoXWrite()

void faudes::AttributeIosState::DoXWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = 0 
) const
protectedvirtual

Writes attribute to TokenWriter, see AttributeVoid for public wrappers. Label and Context argument are ignored.

Parameters
rTwTokenWriter to write to
rLabelSection to write
pContextWrite context to provide contextual information
Exceptions
Exception
  • IO error (id 2)

Reimplemented from faudes::AttributeFlags.

Definition at line 218 of file ios_attributes.cpp.

◆ Error()

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.

◆ Input()

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.

◆ IsDefault()

bool faudes::AttributeIosState::IsDefault ( void  ) const
inlinevirtual

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.

◆ Output()

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.

◆ SetError()

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

Set error flag

Definition at line 317 of file ios_attributes.h.

◆ SetInput()

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.

◆ SetOutput()

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.

◆ ToString()

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

◆ mAllIosFlags

const fType faudes::AttributeIosState::mAllIosFlags = 0x70
staticprotected

Definition at line 400 of file ios_attributes.h.

◆ mDefIosFlags

const fType faudes::AttributeIosState::mDefIosFlags = 0x00
staticprotected

Definition at line 398 of file ios_attributes.h.

◆ mErrorFlag

const fType faudes::AttributeIosState::mErrorFlag = 0x40
static

Definition at line 383 of file ios_attributes.h.

◆ mInputFlag

const fType faudes::AttributeIosState::mInputFlag = 0x10
static

Definition at line 381 of file ios_attributes.h.

◆ mOutputFlag

const fType faudes::AttributeIosState::mOutputFlag = 0x20
static

Definition at line 382 of file ios_attributes.h.


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

libFAUDES 2.33c --- 2025.05.15 --- c++ api documentaion by doxygen