Cyclone ISO C++ API Reference Guide
dds::core::safe_enum< def, inner > Class Template Reference

#include "SafeEnumeration.hpp"

Inherits def.

Public Member Functions

 safe_enum (type v)
 
bool operator!= (const safe_enum &s) const
 
bool operator< (const safe_enum &s) const
 
bool operator<= (const safe_enum &s) const
 
bool operator== (const safe_enum &s) const
 
bool operator> (const safe_enum &s) const
 
bool operator>= (const safe_enum &s) const
 
inner underlying () const
 

Detailed Description

template<typename def, typename inner = typename def::Type>
class dds::core::safe_enum< def, inner >

safe_enum provides a wrapper for enumerated types in a typesafe manner.

safe_enums allow specification of the underlying type, do not implictly convert to integers, and resolve scoping issues.

Definition at line 34 of file SafeEnumeration.hpp.

Constructor & Destructor Documentation

◆ safe_enum()

template<typename def , typename inner = typename def::Type>
dds::core::safe_enum< def, inner >::safe_enum ( type  v)
inline

Definition at line 41 of file SafeEnumeration.hpp.

Member Function Documentation

◆ operator!=()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator!= ( const safe_enum< def, inner > &  s) const
inline

Definition at line 51 of file SafeEnumeration.hpp.

◆ operator<()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator< ( const safe_enum< def, inner > &  s) const
inline

Definition at line 55 of file SafeEnumeration.hpp.

◆ operator<=()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator<= ( const safe_enum< def, inner > &  s) const
inline

Definition at line 59 of file SafeEnumeration.hpp.

◆ operator==()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator== ( const safe_enum< def, inner > &  s) const
inline

Definition at line 47 of file SafeEnumeration.hpp.

◆ operator>()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator> ( const safe_enum< def, inner > &  s) const
inline

Definition at line 63 of file SafeEnumeration.hpp.

◆ operator>=()

template<typename def , typename inner = typename def::Type>
bool dds::core::safe_enum< def, inner >::operator>= ( const safe_enum< def, inner > &  s) const
inline

Definition at line 67 of file SafeEnumeration.hpp.

◆ underlying()

template<typename def , typename inner = typename def::Type>
inner dds::core::safe_enum< def, inner >::underlying ( ) const
inline

Definition at line 42 of file SafeEnumeration.hpp.


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