LuciadCPillar 2024.0.05
luciad::Priority Struct Referencefinal

Priority class that can be used in all kinds of classes. More...

#include <luciad/containers/Priority.h>

Public Member Functions

constexpr Priority (uint32_t value)
 Creates a new priority with the given value. More...
 
uint32_t getValue () const
 Returns the priority value. More...
 
bool operator!= (const Priority &rhs) const
 
bool operator< (const Priority &rhs) const
 
bool operator<= (const Priority &rhs) const
 
bool operator== (const Priority &rhs) const
 
bool operator> (const Priority &rhs) const
 
bool operator>= (const Priority &rhs) const
 

Static Public Member Functions

static const Priorityfallback ()
 Preset priority value that represents a fallback priority. More...
 
static const Priorityhigh ()
 Preset priority value that represents a high priority. More...
 
static const Prioritylow ()
 Preset priority value that represents a low priority. More...
 
static const Prioritynormal ()
 Preset priority value that represents a default priority. More...
 

Detailed Description

Priority class that can be used in all kinds of classes.

For example in composites where it can be used to determine the order in which the delegates are used.

The binary operators that determine the ordering sort priorities from high to low.

Since
2020.1

Constructor & Destructor Documentation

◆ Priority()

constexpr luciad::Priority::Priority ( uint32_t  value)
inlineexplicitconstexpr

Creates a new priority with the given value.

Parameters
valuea priority value. A lower value means a higher priority. The default value is the value of Priority::normal().

Member Function Documentation

◆ fallback()

static const Priority & luciad::Priority::fallback ( )
static

Preset priority value that represents a fallback priority.

Its priority value is 50000. Priority order: High > Normal > Low > Fallback

◆ getValue()

uint32_t luciad::Priority::getValue ( ) const

Returns the priority value.

A lower value means a higher priority.

Returns
the priority value. A lower value means a higher priority.

◆ high()

static const Priority & luciad::Priority::high ( )
static

Preset priority value that represents a high priority.

Its priority value is 5000. Priority order: High > Normal > Low > Fallback

◆ low()

static const Priority & luciad::Priority::low ( )
static

Preset priority value that represents a low priority.

Its priority value is 20000. Priority order: High > Normal > Low > Fallback

◆ normal()

static const Priority & luciad::Priority::normal ( )
static

Preset priority value that represents a default priority.

Its priority value is 10000. Priority order: High > Normal > Low > Fallback

◆ operator!=()

bool luciad::Priority::operator!= ( const Priority rhs) const

◆ operator<()

bool luciad::Priority::operator< ( const Priority rhs) const

◆ operator<=()

bool luciad::Priority::operator<= ( const Priority rhs) const

◆ operator==()

bool luciad::Priority::operator== ( const Priority rhs) const

◆ operator>()

bool luciad::Priority::operator> ( const Priority rhs) const

◆ operator>=()

bool luciad::Priority::operator>= ( const Priority rhs) const