#include <pev_priorities.h>

Public Member Functions

 AttributePriority (void)
 
 AttributePriority (const AttributePriority &rSrc)
 
virtual ~AttributePriority (void)
 
void Clear (void)
 
virtual bool IsDefault (void) const
 
void Priority (Idx prio)
 
Idx Priority (void) const
 
bool operator> (const AttributePriority &rOther) const
 
- Public Member Functions inherited from faudes::AttributeCFlags
 AttributeCFlags (void)
 
virtual ~AttributeCFlags (void)
 
void SetControllable (void)
 
void ClrControllable (void)
 
bool Controllable (void) const
 
void SetObservable (void)
 
void ClrObservable (void)
 
bool Observable (void) const
 
void SetForcible (void)
 
void ClrForcible (void)
 
bool Forcible (void) const
 
void SetHighlevel (void)
 
void SetLowlevel (void)
 
bool Highlevel (void) const
 
bool Lowlevel (void) const
 
Typeoperator= (const Type &rSrc)
 
bool operator== (const Type &rOther) const
 
bool operator!= (const Type &rOther) 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)
 
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 AttributePriority &rSrcAttr)
 
bool DoEqual (const AttributePriority &rOther) const
 
virtual void DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=nullptr)
 
virtual void DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=nullptr) const
 
virtual void DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=nullptr) const
 
- Protected Member Functions inherited from faudes::AttributeCFlags
void DoAssign (const AttributeCFlags &rSrcAttr)
 
bool DoEqual (const AttributeCFlags &rOther) 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
 

Protected Attributes

Idx mPriority = 0
 

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::AttributeCFlags
static const fType mControllableFlag =0x01
 
static const fType mObservableFlag =0x02
 
static const fType mForcibleFlag =0x04
 
static const fType mAbstractionFlag =0x08
 
- Static Public Attributes inherited from faudes::AttributeFlags
static const fType mDefFlags =0x0
 

Detailed Description

The class AttributePriority is intendened to be used as an event attribute. the class is derived from AttributeCFlags and accommedates an additional non-negative integer to represent an event priority. See also the template TpEventSet<Attr> for a convenience wrapper of an alphabet with attributes of type AttributePriority per event..

Definition at line 39 of file pev_priorities.h.

Constructor & Destructor Documentation

◆ AttributePriority() [1/2]

faudes::AttributePriority::AttributePriority ( void  )
inline

Default constructor, sets priority to 0

Definition at line 47 of file pev_priorities.h.

◆ AttributePriority() [2/2]

faudes::AttributePriority::AttributePriority ( const AttributePriority rSrc)
inline

Copy constructor.

Definition at line 52 of file pev_priorities.h.

◆ ~AttributePriority()

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

Destructor

Definition at line 56 of file pev_priorities.h.

Member Function Documentation

◆ Clear()

void faudes::AttributePriority::Clear ( void  )
inlinevirtual

Clear to default (mandatory for serialisation)

Reimplemented from faudes::AttributeVoid.

Definition at line 61 of file pev_priorities.h.

◆ DoAssign()

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

Assignment method.

Parameters
rSrcAttrSource to assign from

Definition at line 51 of file pev_priorities.cpp.

◆ DoEqual()

bool faudes::AttributePriority::DoEqual ( const AttributePriority rOther) const
protected

Test equality of configuration data.

Parameters
rOtherOther attribute to compare with.
Returns
True on match.

Definition at line 60 of file pev_priorities.cpp.

◆ DoRead()

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

Reads attribute from TokenReader, see AttributeVoid for public wrappers. Label and Context argument are ignored.

Parameters
rTrTokenReader to read from
rLabelSection to read
pContextRead context to provide contextual information
Exceptions
Exception
  • IO error (id 1)

Reimplemented from faudes::AttributeCFlags.

Definition at line 91 of file pev_priorities.cpp.

◆ DoWrite()

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

Writes attribute to TokenWriter, see AttributeVoid for public wrappers. Note: this class always wrtites in XML. Note: 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::AttributeCFlags.

Definition at line 86 of file pev_priorities.cpp.

◆ DoXWrite()

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

Writes attribute to TokenWriter, see AttributeVoid for public wrappers. Note: this class always wrtites in XML. Note: 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::AttributeCFlags.

Definition at line 70 of file pev_priorities.cpp.

◆ IsDefault()

virtual bool faudes::AttributePriority::IsDefault ( void  ) const
inlinevirtual

Test for default value

Returns
True, if this attribute has its default value

Reimplemented from faudes::AttributeCFlags.

Definition at line 69 of file pev_priorities.h.

◆ operator>()

bool faudes::AttributePriority::operator> ( const AttributePriority rOther) const
inline

compare priority (a>b iff a preempts b)

Definition at line 79 of file pev_priorities.h.

◆ Priority() [1/2]

void faudes::AttributePriority::Priority ( Idx  prio)
inline

set priority

Definition at line 73 of file pev_priorities.h.

◆ Priority() [2/2]

Idx faudes::AttributePriority::Priority ( void  ) const
inline

get priority

Definition at line 76 of file pev_priorities.h.

Member Data Documentation

◆ mPriority

Idx faudes::AttributePriority::mPriority = 0
protected

priority value. 0 is highest.

Definition at line 88 of file pev_priorities.h.


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

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