HOPS
HOPS class reference
Static Public Member Functions | List of all members
hops::MHO_ClassIdentity Class Reference

Class MHO_ClassIdentity. More...

#include <MHO_ClassIdentity.hh>

Static Public Member Functions

template<typename XClassType >
static std::string ClassName ()
 Returns the class name as a string. More...
 
template<typename XClassType >
static std::string ClassName (const XClassType &)
 Returns the class name as a string. More...
 
template<typename XClassType >
static void ClassVersionErrorMsg (const XClassType &obj, MHO_ClassVersion version)
 Generates an error message for when an unknown or unsupported class version is encountered. More...
 
template<typename XClassType >
static MHO_UUID GetUUIDFromClass ()
 Returns the class name as a string. More...
 
template<typename XClassType >
static MHO_UUID GetUUIDFromClass (const XClassType &)
 Returns the UUID associated with a class type. More...
 
static MHO_UUID GetUUIDFromClassName (std::string name)
 Generates a UUID from the class name. More...
 

Detailed Description

Class MHO_ClassIdentity.

template class to produce the name of XClassType at runtime

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Wed Apr 21 13:40:18 2021 -0400

Member Function Documentation

◆ ClassName() [1/2]

template<typename XClassType >
static std::string hops::MHO_ClassIdentity::ClassName ( )
inlinestatic

Returns the class name as a string.

Template Parameters
XClassTypeThe type of the class for which the name is requested.
Returns
std::string The name of the class.

◆ ClassName() [2/2]

template<typename XClassType >
static std::string hops::MHO_ClassIdentity::ClassName ( const XClassType &  )
inlinestatic

Returns the class name as a string.

Template Parameters
XClassTypeThe type of the class for which the name is requested.
Parameters
objAn instance of the class (unused in function).
Returns
std::string The name of the class.

◆ ClassVersionErrorMsg()

template<typename XClassType >
static void hops::MHO_ClassIdentity::ClassVersionErrorMsg ( const XClassType &  obj,
MHO_ClassVersion  version 
)
inlinestatic

Generates an error message for when an unknown or unsupported class version is encountered.

Template Parameters
XClassTypeThe type of the class for which the error message is generated.
Parameters
objAn instance of the class.
versionThe unsupported class version.

◆ GetUUIDFromClass() [1/2]

template<typename XClassType >
static MHO_UUID hops::MHO_ClassIdentity::GetUUIDFromClass ( )
inlinestatic

Returns the class name as a string.

Template Parameters
XClassTypeThe type of the class for which the name is requested.
Parameters
objAn instance of the class (unused in function).
Returns
std::string The name of the class.

◆ GetUUIDFromClass() [2/2]

template<typename XClassType >
static MHO_UUID hops::MHO_ClassIdentity::GetUUIDFromClass ( const XClassType &  )
inlinestatic

Returns the UUID associated with a class type.

Template Parameters
XClassTypeThe type of the class for which the UUID is requested.
Parameters
objAn instance of the class (unused in function).
Returns
MHO_UUID The UUID of the class.

◆ GetUUIDFromClassName()

static MHO_UUID hops::MHO_ClassIdentity::GetUUIDFromClassName ( std::string  name)
inlinestatic

Generates a UUID from the class name.

Parameters
nameThe name of the class.
Returns
MHO_UUID The generated UUID for the class name.

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