The AttributePGenGl class Class wraping various global attributes of a FPGen including Fairness and lowest event priority. Note: this is not yet a propper faudes Attribute, it misses out on serialisation. More...

#include <pev_pgenerator.h>

Public Member Functions

 AttributePGenGl (void)
 
virtual ~AttributePGenGl (void)
 
void LowestPriority (const Idx rPriority)
 
Idx LowestPriority (void) const
 
void HighestPriority (const Idx rPriority)
 
Idx HighestPriority (void) const
 
void Fairness (const FairnessConstraints &rFair)
 
const FairnessConstraintsFairness (void) const
 
void Clear (void)
 
- Public Member Functions inherited from faudes::AttributeVoid
 AttributeVoid (void)
 
 AttributeVoid (const AttributeVoid &rSrcAttr)
 
virtual ~AttributeVoid (void)
 
virtual bool IsDefault (void) const
 
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 AttributePGenGl &rSrcAttr)
 
bool DoEqual (const AttributePGenGl &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
 
- 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 DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) 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

FairnessConstraints mFairConsts
 mFairConst fairness constraints More...
 
Idx mPLowest = 0
 
Idx mPHighest = 0
 

Additional Inherited Members

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

Detailed Description

The AttributePGenGl class Class wraping various global attributes of a FPGen including Fairness and lowest event priority. Note: this is not yet a propper faudes Attribute, it misses out on serialisation.

Definition at line 40 of file pev_pgenerator.h.

Constructor & Destructor Documentation

◆ AttributePGenGl()

faudes::AttributePGenGl::AttributePGenGl ( void  )
inline

Default constructor

Definition at line 48 of file pev_pgenerator.h.

◆ ~AttributePGenGl()

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

Destructor

Definition at line 51 of file pev_pgenerator.h.

Member Function Documentation

◆ Clear()

void faudes::AttributePGenGl::Clear ( void  )
inlinevirtual

Clear (mandatory for serialisation)

Reimplemented from faudes::AttributeVoid.

Definition at line 64 of file pev_pgenerator.h.

◆ DoAssign()

void faudes::AttributePGenGl::DoAssign ( const AttributePGenGl rSrcAttr)
inlineprotected

Assignment method.

Parameters
rSrcAttrSource to assign from

Definition at line 73 of file pev_pgenerator.h.

◆ DoEqual()

bool faudes::AttributePGenGl::DoEqual ( const AttributePGenGl rOther) const
inlineprotected

Test equality of configuration data.

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

Definition at line 83 of file pev_pgenerator.h.

◆ DoRead()

virtual void faudes::AttributePGenGl::DoRead ( TokenReader rTr,
const std::string &  rLabel = "",
const Type pContext = nullptr 
)
inlineprotectedvirtual

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

Definition at line 99 of file pev_pgenerator.h.

◆ DoWrite()

virtual void faudes::AttributePGenGl::DoWrite ( TokenWriter rTw,
const std::string &  rLabel = "",
const Type pContext = nullptr 
) const
inlineprotectedvirtual

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

Definition at line 115 of file pev_pgenerator.h.

◆ Fairness() [1/2]

void faudes::AttributePGenGl::Fairness ( const FairnessConstraints rFair)
inline

Definition at line 58 of file pev_pgenerator.h.

◆ Fairness() [2/2]

const FairnessConstraints& faudes::AttributePGenGl::Fairness ( void  ) const
inline

Definition at line 59 of file pev_pgenerator.h.

◆ HighestPriority() [1/2]

void faudes::AttributePGenGl::HighestPriority ( const Idx  rPriority)
inline

Definition at line 56 of file pev_pgenerator.h.

◆ HighestPriority() [2/2]

Idx faudes::AttributePGenGl::HighestPriority ( void  ) const
inline

Definition at line 57 of file pev_pgenerator.h.

◆ LowestPriority() [1/2]

void faudes::AttributePGenGl::LowestPriority ( const Idx  rPriority)
inline

Access members

Definition at line 54 of file pev_pgenerator.h.

◆ LowestPriority() [2/2]

Idx faudes::AttributePGenGl::LowestPriority ( void  ) const
inline

Definition at line 55 of file pev_pgenerator.h.

Member Data Documentation

◆ mFairConsts

FairnessConstraints faudes::AttributePGenGl::mFairConsts
protected

mFairConst fairness constraints

Definition at line 121 of file pev_pgenerator.h.

◆ mPHighest

Idx faudes::AttributePGenGl::mPHighest = 0
protected

highest priority value of globally all events (not only my alphabet).

Definition at line 131 of file pev_pgenerator.h.

◆ mPLowest

Idx faudes::AttributePGenGl::mPLowest = 0
protected

lowest priority value of globally all events (not only my alphabet).

Definition at line 126 of file pev_pgenerator.h.


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

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