lintel 0.2.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
lintel::MessageQueues Class Reference

#include <MessageQueues.h>

Public Types

enum  Value { UNDEFINED = -1 , HISTORY = 0 }
 

Public Member Functions

 MessageQueues ()=default
 
constexpr MessageQueues (Value value)
 
constexpr MessageQueues (std::string_view enumName)
 
 operator Value () const
 
 operator bool ()=delete
 
std::string toString () const
 
std::string getMessageQueueName () const
 

Static Public Member Functions

static std::set< Value > values ()
 

Friends

std::ostream & operator<< (std::ostream &os, const MessageQueues &connectionType)
 

Detailed Description

list of all available MessageQueues

Member Enumeration Documentation

◆ Value

Available message queue identifiers.

Enumerator
UNDEFINED 

Undefined / unset

HISTORY 

History message queue

Constructor & Destructor Documentation

◆ MessageQueues() [1/3]

lintel::MessageQueues::MessageQueues ( )
default

Default constructor (sets value to UNDEFINED).

◆ MessageQueues() [2/3]

constexpr lintel::MessageQueues::MessageQueues ( Value  value)
inlineconstexpr
Parameters
valueenum value

◆ MessageQueues() [3/3]

constexpr lintel::MessageQueues::MessageQueues ( std::string_view  enumName)
inlineexplicitconstexpr

Construct from a string representation of the enum name.

Parameters
enumNameenum name string

Member Function Documentation

◆ getMessageQueueName()

std::string lintel::MessageQueues::getMessageQueueName ( ) const
inline
Returns
the message queue name for this enum value
Exceptions
std::runtime_errorif value is UNDEFINED

◆ operator bool()

lintel::MessageQueues::operator bool ( )
explicitdelete

◆ operator Value()

lintel::MessageQueues::operator Value ( ) const
inline
Returns
the underlying enum value

◆ toString()

std::string lintel::MessageQueues::toString ( ) const
inline
Returns
string representation of the enum value

◆ values()

static std::set< Value > lintel::MessageQueues::values ( )
inlinestatic
Returns
all defined enum values

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const MessageQueues &  connectionType 
)
friend

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