#include <ios_attributes.h>

Public Member Functions

 AttributeIosEvent (void)
 
 AttributeIosEvent (const AttributeIosEvent &rSrc)
 
virtual ~AttributeIosEvent (void)
 
void SetOutput (void)
 
void ClrOutput (void)
 
void SetInput (void)
 
void ClrInput (void)
 
bool Output (void) const
 
bool Input (void) const
 
bool IsDefault (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)
 

Protected Member Functions

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

Additional Inherited Members

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

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

◆ AttributeIosEvent() [1/2]

faudes::AttributeIosEvent::AttributeIosEvent ( void  )
inline

Default constructor

Definition at line 49 of file ios_attributes.h.

◆ AttributeIosEvent() [2/2]

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

Copy constructor

Definition at line 56 of file ios_attributes.h.

◆ ~AttributeIosEvent()

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

Destructor

Definition at line 63 of file ios_attributes.h.

Member Function Documentation

◆ ClrInput()

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.

◆ ClrOutput()

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.

◆ DoAssign()

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

Assignment method.

Parameters
rSrcAttrSource to assign from

Definition at line 36 of file ios_attributes.cpp.

◆ DoRead()

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

◆ DoWrite()

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

◆ DoXWrite()

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

◆ Input()

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.

◆ IsDefault()

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

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.

◆ Output()

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.

◆ SetInput()

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.

◆ SetOutput()

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

◆ mAllIosFlags

const fType faudes::AttributeIosEvent::mAllIosFlags =0x030
staticprotected

Definition at line 156 of file ios_attributes.h.

◆ mDefIosFlags

const fType faudes::AttributeIosEvent::mDefIosFlags =0x000
staticprotected

Definition at line 153 of file ios_attributes.h.

◆ mInputFlag

const fType faudes::AttributeIosEvent::mInputFlag =0x010
staticprotected

Definition at line 149 of file ios_attributes.h.

◆ mOutputFlag

const fType faudes::AttributeIosEvent::mOutputFlag =0x020
staticprotected

Definition at line 150 of file ios_attributes.h.


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

libFAUDES 2.33b --- 2025.05.07 --- c++ api documentaion by doxygen