faudes::TpEventSet< Attr > Class Template Reference

Detailed Description

template<class Attr>
class faudes::TpEventSet< Attr >

The template TpEventSet<Attr> provides access members for event priorities. The template parameter is expected to be a descendant of AttributePriority. There also is the convenience typedef faudes::EventPriorities for this intended usecase.

Token IO is proper XML with default priority 0. Example:

<Alphabet>
<!-- avent alpha with priority 10 -->
<Event name="alpha">
<Priority value="10"/>
</Event>
<!-- avent beta with default priority 0 -->
<Event name="beta"/>
<Priority value="20"/>
</Event>
</Alphabet>  

Definition at line 197 of file pev_priorities.h.

#include <pev_priorities.h>

Protected Member Functions
virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=nullptr) const

Private Member Functions
	TpEventSet (void)
	TpEventSet (const EventSet &rOther)
	TpEventSet (const TpEventSet &rOther)
	TpEventSet (const std::string &rFileName, const std::string &rLabel="")
Idx	Priority (const std::string &rName) const
Idx	Priority (const Idx idx) const
void	Priority (const std::string &rName, const Idx prio)
void	Priority (const Idx idx, const Idx prio)
void	InsPriority (const Idx idx, const Idx prio)
void	InsPriority (const std::string &rName, const Idx prio)
void	Priorities (const TpEventSet &rOtherSet)
Idx	LowestPriority (void) const
Idx	HighestPriority (void) const
void	NormalisePriorities (void)

Constructor & Destructor Documentation

TpEventSet() [1/4]

template<class Attr >

faudes::TpEventSet< Attr >::TpEventSet ( void  )

inlineprivate

std faudes type declarations Default constructor

Definition at line 205 of file pev_priorities.h.

TpEventSet() [2/4]

template<class Attr >

faudes::TpEventSet< Attr >::TpEventSet ( const EventSet &  rOther )

inlineprivate

Copy constructor

Parameters

rOther

Definition at line 212 of file pev_priorities.h.

TpEventSet() [3/4]

template<class Attr >

faudes::TpEventSet< Attr >::TpEventSet ( const TpEventSet< Attr > &  rOther )

inlineprivate

Copy constructor

Parameters

rOther

Definition at line 219 of file pev_priorities.h.

TpEventSet() [4/4]

template<class Attr >

faudes::TpEventSet< Attr >::TpEventSet ( const std::string &  rFileName, const std::string &  rLabel = ""  )

inlineprivate

Construct from file

Parameters

rFileName	Filename
rLabel	Label to read from

Exceptions

Exception

If opening/reading fails an Exception object is thrown (id 1, 50, 51)

Definition at line 232 of file pev_priorities.h.

Member Function Documentation

DoWrite()

template<class Attr >

virtual void faudes::TpEventSet< Attr >::DoWrite ( TokenWriter &  rTw, const std::string &  rLabel = "", const Type *  pContext = nullptr  ) const

inlineprotectedvirtual

Reimplement DoWrite to enforce XML token-io

Parameters

rTw	TokenWriter to write to
rLabel	Section to write
pContext	Write context to provide contextual information

Exceptions

Exception

IO error (id 2)

Definition at line 410 of file pev_priorities.h.

HighestPriority()

template<class Attr >

Idx faudes::TpEventSet< Attr >::HighestPriority ( void  ) const

inlineprivate

Get highest priority

Returns

highest priority

Definition at line 362 of file pev_priorities.h.

InsPriority() [1/2]

template<class Attr >

void faudes::TpEventSet< Attr >::InsPriority ( const Idx  idx, const Idx  prio  )

inlineprivate

Insert with priority by index

Parameters

idx	spcify element
prio	specify priority

Definition at line 305 of file pev_priorities.h.

InsPriority() [2/2]

template<class Attr >

void faudes::TpEventSet< Attr >::InsPriority ( const std::string &  rName, const Idx  prio  )

inlineprivate

Insert with priority by name

Parameters

rName	spcify element
prio	specify priority

Definition at line 319 of file pev_priorities.h.

LowestPriority()

template<class Attr >

Idx faudes::TpEventSet< Attr >::LowestPriority ( void  ) const

inlineprivate

Get lowest priority

Returns

lowest priority

Definition at line 346 of file pev_priorities.h.

NormalisePriorities()

template<class Attr >

void faudes::TpEventSet< Attr >::NormalisePriorities ( void  )

inlineprivate

Normalise priorities

Rearrange priorities to be consecutive intergers ranging from 1 to the highest priority.

Definition at line 379 of file pev_priorities.h.

Priorities()

template<class Attr >

void faudes::TpEventSet< Attr >::Priorities ( const TpEventSet< Attr > &  rOtherSet )

inlineprivate

Set Priorities from other prioritised event set

Parameters

rOtherSet

set to get priorities from

Definition at line 331 of file pev_priorities.h.

Priority() [1/4]

template<class Attr >

Idx faudes::TpEventSet< Attr >::Priority ( const Idx  idx ) const

inlineprivate

Get Priority by index

Parameters

rIdx	specify element

Exceptions

Exception

Base class with throw if specified element does not exist

Returns

priority of specified event

Definition at line 263 of file pev_priorities.h.

Priority() [2/4]

template<class Attr >

void faudes::TpEventSet< Attr >::Priority ( const Idx  idx, const Idx  prio  )

inlineprivate

Set Priority by index

Parameters

idx	spcify element
prio	specify priority

Exceptions

Exception

Base class with throw if specified element does not exist

Definition at line 293 of file pev_priorities.h.

Priority() [3/4]

template<class Attr >

Idx faudes::TpEventSet< Attr >::Priority ( const std::string &  rName ) const

inlineprivate

Get priority by symbolic name

Parameters

rName

specify element

Exceptions

Exception

Base class with throw if synbol does not exist

Returns

priority of specified event

Definition at line 250 of file pev_priorities.h.

Priority() [4/4]

template<class Attr >

void faudes::TpEventSet< Attr >::Priority ( const std::string &  rName, const Idx  prio  )

inlineprivate

Set priority by symbolic name

Parameters

rName	specify element
prio	specify priority

Exceptions

Exception

Base class with throw if synbol does not exist

Definition at line 278 of file pev_priorities.h.

---

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

• pev_priorities.h