Detailed Description

Boolean flags Attribute.

This attribute class uses a flag word to represent boolean values. The current implementation uses a long int type and hence handles up to 32 flags. Each flag is accessed by the according bit mask.

The current version of libFAUDES uses bits 0,1,2 of event attributes for controllability properties (see AttributeCFlags) and the bits 31 and 32 of state attributes for the Qt based GUI project. Further versions may use the lower 8 bits of the event aflags and the higher 8 bits of state flags. You are free to use any flags for your application, but if possible try to avoid the above mentioned. For extensive use of flags, you may also consider to define a separate attribute class, perhaps with a different fType.

Definition at line 207 of file cfl_attributes.h.

#include <cfl_attributes.h>

Public Member Functions
	AttributeFlags (void)
	Default constructor. More...

	AttributeFlags (const AttributeFlags &rOther)
	Copy constructor. More...

virtual	~AttributeFlags (void)
	Destructor. More...

bool	Test (fType mask) const
	Test a flag. More...

bool	TestAll (fType mask) const
	Test multible flags, combine by "and". More...

bool	TestSome (fType mask) const
	Test multible flags, combine by "or". More...

bool	TestNone (fType mask) const
	Test multible flags, combine by "not or". More...

void	Set (fType mask)
	Set multiple flags. More...

void	Clr (fType mask)
	Clear multiple flags. More...

virtual bool	IsDefault (void) const
	Test for default value. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

Public Member Functions inherited from faudes::AttributeVoid
	AttributeVoid (void)
	Constructor. More...

	AttributeVoid (const AttributeVoid &rSrcAttr)
	Copy Constructor. More...

virtual	~AttributeVoid (void)
	Destructor. More...

virtual void	SetDefault (void)
	Set to default value. More...

virtual void	Clear (void)
	Synonym for SetDefault to match std interface. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

Public Member Functions inherited from faudes::Type
	Type (void)
	Constructor. More...

	Type (const Type &rType)
	Copy constructor. More...

virtual	~Type (void)
	Destructor. More...

virtual Type *	New (void) const
	Construct on heap. More...

virtual Type *	Copy (void) const
	Construct on heap. More...

virtual const Type *	Cast (const Type *pOther) const
	Cast other object to this type. More...

virtual Type &	Assign (const Type &rSrc)
	Assign configuration data from other object. More...

Type &	operator= (const Type &rSrc)
	Assign configurationdata from other object. More...

virtual bool	Equal (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator== (const Type &rOther) const
	Test equality of configuration data. More...

bool	operator!= (const Type &rOther) const
	Test equality of configuration data. More...

virtual void	Name (const std::string &rName)
	Set the objects's name. More...

virtual const std::string &	Name (void) const
	Get objects's name. More...

virtual const std::string &	TypeName (void) const
	Get objects's type name. More...

void	Write (const Type *pContext=0) const
	Write configuration data to console. More...

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
	Write configuration data to a file. More...

void	Write (const std::string &pFileName, std::ios::openmode openmode) const
	Write configuration data to a file. More...

void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to TokenWriter. More...

virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to an XML file. More...

void	XWrite (const Type *pContext=0) const
	Write configuration data in XML format to concole Note: this write function uses the virtual function DoXWrite(), to be reimplemented by derived classes. More...

void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in XML format to TokenWriter. More...

std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a string. More...

std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data to a formated string. More...

void	DWrite (const Type *pContext=0) const
	Write configuration data to console, debugging format. More...

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
	Write configuration data to a file, debugging format. More...

void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write configuration data in debug format to TokenWriter. More...

void	SWrite (TokenWriter &rTw) const
	Write statistics comment to TokenWriter. More...

void	SWrite (void) const
	Write statistics comment to console. More...

std::string	ToSText (void) const
	Write statistics to a string. More...

void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from file with label specified. More...

void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from a string. More...

void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Read configuration data from TokenReader with label sepcified. More...

Public Attributes
fType	mFlags
	Flags (public access for convenience) More...

Static Public Attributes
static const fType	mDefFlags =0x0

Protected Member Functions
void	DoAssign (const AttributeFlags &rSrcAttr)
	Assignment method. More...

bool	DoEqual (const AttributeFlags &rOther) const
	Test equality of configuration data. More...

virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
	Reads attribute from TokenReader, see Type for public wrappers. More...

virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write to TokenWriter, see Type for public wrappers. More...

virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Write to TokenWriter, see Type for public wrappers. More...

Protected Member Functions inherited from faudes::AttributeVoid
void	DoAssign (const AttributeVoid &rSrcAttr)
	Assign attribute members. More...

bool	DoEqual (const AttributeVoid &rOther) const
	Test equality of configuration data. More...

virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
	Actual write method to write the attribute to a TokenWriter. More...

Protected Member Functions inherited from faudes::Type
void	DoAssign (const Type &rSrc)
	Assign configuration data from other object. More...

bool	DoEqual (const Type &rOther) const
	Test equality of configuration data. More...

virtual void	DoSWrite (TokenWriter &rTw) const
	Write statistical data as a comment to TokenWriter. More...

virtual const TypeDefinition *	TypeDefinitionp (void) const
	Get objects's type definition. More...

virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Additional Inherited Members
Static Public Member Functions inherited from faudes::AttributeVoid
static void	Skip (TokenReader &rTr)
	Skip attribute tokens. More...

Constructor & Destructor Documentation

◆ AttributeFlags() [1/2]

faudes::AttributeFlags::AttributeFlags ( void )

inline

Default constructor.

Definition at line 218 of file cfl_attributes.h.

◆ AttributeFlags() [2/2]

faudes::AttributeFlags::AttributeFlags ( const AttributeFlags & rOther )

inline

Copy constructor.

Definition at line 221 of file cfl_attributes.h.

◆ ~AttributeFlags()

virtual faudes::AttributeFlags::~AttributeFlags ( void )

inlinevirtual

Destructor.

Definition at line 224 of file cfl_attributes.h.

Member Function Documentation

◆ Clr()

void faudes::AttributeFlags::Clr ( fType mask )

inline

Clear multiple flags.

Definition at line 254 of file cfl_attributes.h.

◆ DoAssign()

void faudes::AttributeFlags::DoAssign ( const AttributeFlags & rSrcAttr )

protected

Assignment method.

Parameters

rSrcAttr Source to assign from

Definition at line 114 of file cfl_attributes.cpp.

◆ DoEqual()

bool faudes::AttributeFlags::DoEqual ( const AttributeFlags & rOther ) const

protected

Test equality of configuration data.

Parameters

rOther Other object to compare with.

Returns: True on match.

Definition at line 122 of file cfl_attributes.cpp.

◆ DoRead()

void faudes::AttributeFlags::DoRead	(	TokenReader &	rTr,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)

protectedvirtual

Reads attribute from TokenReader, see Type for public wrappers.

Test whether the current token is an integer with base 16. If so, read the token to the flags value. Else, dont take any tokens. The label and context arguments are ignored.

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

Reimplemented in faudes::AttributeCFlags, faudes::AttributeTimedState, faudes::AttributeTimedTrans, faudes::SimEventAttribute, faudes::AttributeSimCondition, faudes::AttributeColoredState, faudes::AttributeIosState, faudes::AttributeIosEvent, faudes::AttributeLhaState, faudes::AttributeLhaTrans, faudes::HioStateFlags, faudes::HioEventFlags, faudes::AttributeFailureTypeMap, faudes::AttributeFailureEvents, faudes::DiagLabelSet, and faudes::AttributeDiagnoserState.

Definition at line 155 of file cfl_attributes.cpp.

◆ DoWrite()

void faudes::AttributeFlags::DoWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)		const

protectedvirtual

Write to TokenWriter, see Type for public wrappers.

If not the defult value, write the flag value as base 16 integer token. Else, do nothing. The label and context arguments are ignored.

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeTimedState, faudes::AttributeTimedTrans, faudes::SimEventAttribute, faudes::AttributeSimCondition, faudes::AttributeColoredState, faudes::AttributeIosState, faudes::AttributeIosEvent, faudes::AttributeLhaState, faudes::AttributeLhaTrans, faudes::HioStateFlags, faudes::HioEventFlags, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::AttributeFailureEvents, and faudes::AttributeDiagnoserState.

Definition at line 130 of file cfl_attributes.cpp.

◆ DoXWrite()

void faudes::AttributeFlags::DoXWrite	(	TokenWriter &	rTw,
		const std::string &	rLabel = `""`,
		const Type *	pContext = `0`
	)		const

protectedvirtual

Write to TokenWriter, see Type for public wrappers.

If not the defult value, write the flags in XML format. Else, do nothing. The label and context arguments are ignored.

Parameters

rTw	Reference to TokenWriter
rLabel	Label of section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO errors (id 2)

Reimplemented from faudes::Type.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeColoredState, faudes::AttributeIosState, faudes::AttributeIosEvent, faudes::AttributeLhaState, faudes::AttributeLhaTrans, faudes::AttributeFailureTypeMap, faudes::DiagLabelSet, faudes::AttributeFailureEvents, and faudes::AttributeDiagnoserState.

Definition at line 142 of file cfl_attributes.cpp.

◆ IsDefault()

virtual bool faudes::AttributeFlags::IsDefault ( void ) const

inlinevirtual

Test for default value.

Reimplemented from faudes::AttributeVoid.

Reimplemented in faudes::AttributeCFlags, faudes::AttributeTimedState, faudes::AttributeTimedTrans, faudes::SimEventAttribute, faudes::AttributeSimCondition, faudes::AttributeColoredState, faudes::AttributeIosState, faudes::AttributeIosEvent, faudes::AttributeLhaState, faudes::AttributeLhaTrans, faudes::HioStateFlags, faudes::HioEventFlags, faudes::DiagLabelSet, faudes::AttributeFailureTypeMap, faudes::AttributeFailureEvents, and faudes::AttributeDiagnoserState.

Definition at line 259 of file cfl_attributes.h.

◆ operator!=()

bool faudes::Type::operator!=

Test equality of configuration data.

See operator==(const Type&).

This method calls the virtual method DoEqual(). Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters

rOther Other objevt to compare with.

Returns: True on mismatch.

Definition at line 60 of file cfl_types.cpp.

◆ operator=()

Type & faudes::Type::operator=

Assign configurationdata from other object.

Derived classes should implement the operator form for the assignment for each source type which allows for a non-trivial assignment. This includes the particular case were the source and destination types match exactly. In the latter case the DoAssign method should be invoked. In contrast to the Assign function, the operator form must not be reimplemented for missmatched source types: the operator form only accepts sensible source types. This allows for compiletime typeckecking. However, the downside is that when the type is not known at compiletime, configuration is not properly assigned.

Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters

rSrc	Source to copy from

Returns: Reference to this object.

Definition at line 58 of file cfl_types.cpp.

◆ operator==()

bool faudes::Type::operator==

Test equality of configuration data.

The operator form of the equality test is only defined for matching types, no cast will be performed. Thus, the test will be optimistic if the type is not known at compiletime. The object name or id is not considered in the test.

This methoc calls the virtual method DoEqual(). Re-implementation can be done via the convenience macros FAUDES_TYPE_DECLARATION and FAUDES_TYPE_IMPLEMENTATION.

Parameters

rOther Other object to compare with.

Returns: True on match.

Definition at line 59 of file cfl_types.cpp.

◆ Set()

void faudes::AttributeFlags::Set ( fType mask )

inline

Set multiple flags.

Definition at line 249 of file cfl_attributes.h.

◆ Test()

bool faudes::AttributeFlags::Test ( fType mask ) const

inline

Test a flag.

Definition at line 229 of file cfl_attributes.h.

◆ TestAll()

bool faudes::AttributeFlags::TestAll ( fType mask ) const

inline

Test multible flags, combine by "and".

Definition at line 234 of file cfl_attributes.h.

◆ TestNone()

bool faudes::AttributeFlags::TestNone ( fType mask ) const

inline

Test multible flags, combine by "not or".

Definition at line 244 of file cfl_attributes.h.

◆ TestSome()

bool faudes::AttributeFlags::TestSome ( fType mask ) const

inline

Test multible flags, combine by "or".

Definition at line 239 of file cfl_attributes.h.

Member Data Documentation

◆ mDefFlags

const fType faudes::AttributeFlags::mDefFlags =0x0

static

Definition at line 265 of file cfl_attributes.h.

◆ mFlags

fType faudes::AttributeFlags::mFlags

Flags (public access for convenience)

Definition at line 262 of file cfl_attributes.h.

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

Detailed Description

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AttributeFlags() [1/2]

◆ AttributeFlags() [2/2]

◆ ~AttributeFlags()

Member Function Documentation

◆ Clr()

◆ DoAssign()

◆ DoEqual()

◆ DoRead()

◆ DoWrite()

◆ DoXWrite()

◆ IsDefault()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ Set()

◆ Test()

◆ TestAll()

◆ TestNone()

◆ TestSome()

Member Data Documentation

◆ mDefFlags

◆ mFlags