OpFlex Framework  1.7.0
opflex::modb::ConstInfo Class Reference

Const info defines a specific enum member. More...

#include <opflex/modb/ConstInfo.h>

Public Member Functions

 ConstInfo (const std::string &name_, uint64_t id_)
 Construct a const info object with the given name and ID.
 
 ~ConstInfo ()
 Destructor.
 
const std::string & getName () const
 Get the name for this const. More...
 
const uint64_t getId () const
 Get the unique ID for this const within the enclosing enum. More...
 

Detailed Description

Const info defines a specific enum member.

This metadata is generated by the code generation framework and is required when the framework is initialized.

Member Function Documentation

◆ getId()

const uint64_t opflex::modb::ConstInfo::getId ( ) const
inline

Get the unique ID for this const within the enclosing enum.

Returns
the const ID within the enum

◆ getName()

const std::string& opflex::modb::ConstInfo::getName ( ) const
inline

Get the name for this const.

This value is used to represent this const in JSON documents.

Returns
the const name

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