HOPS
HOPS class reference
Public Member Functions | Protected Attributes | List of all members
hops::MHO_ChannelIndexLabeler Class Reference

Class MHO_ChannelIndexLabeler. More...

#include <MHO_EncodeDecodeValue.hh>

Inheritance diagram for hops::MHO_ChannelIndexLabeler:
[legend]

Public Member Functions

 MHO_ChannelIndexLabeler ()
 
virtual ~MHO_ChannelIndexLabeler ()
 
uint64_t DecodeLabelToValue (const std::string &label) const
 Decodes a channel label to its corresponding value. More...
 
std::string EncodeValueToLabel (const uint64_t &value) const
 Encodes a uint64_t value into a label string using default and extended encoding schemes. More...
 
void SetDefaultChannelChars (const std::string &ch_set)
 Setter for channel chars - provides the option to use different character sets. More...
 
void SetExtendedChannelChars (const std::string &ex_set)
 Setter for extended channel chars. More...
 

Protected Attributes

std::string fDefaultChannelChars
 
std::string fExtendedChannelChars
 

Detailed Description

Class MHO_ChannelIndexLabeler.

Constructor & Destructor Documentation

◆ MHO_ChannelIndexLabeler()

hops::MHO_ChannelIndexLabeler::MHO_ChannelIndexLabeler ( )
inline

◆ ~MHO_ChannelIndexLabeler()

virtual hops::MHO_ChannelIndexLabeler::~MHO_ChannelIndexLabeler ( )
inlinevirtual

Member Function Documentation

◆ DecodeLabelToValue()

uint64_t hops::MHO_ChannelIndexLabeler::DecodeLabelToValue ( const std::string &  label) const
inline

Decodes a channel label to its corresponding value.

Parameters
labelInput channel label string.
Returns
Decoded channel value as uint64_t.

◆ EncodeValueToLabel()

std::string hops::MHO_ChannelIndexLabeler::EncodeValueToLabel ( const uint64_t &  value) const
inline

Encodes a uint64_t value into a label string using default and extended encoding schemes.

Parameters
valueInput value to be encoded as a label.
Returns
Encoded label string representation of the input value.

◆ SetDefaultChannelChars()

void hops::MHO_ChannelIndexLabeler::SetDefaultChannelChars ( const std::string &  ch_set)
inline

Setter for channel chars - provides the option to use different character sets.

Parameters
ch_setInput character set to use as defaults

◆ SetExtendedChannelChars()

void hops::MHO_ChannelIndexLabeler::SetExtendedChannelChars ( const std::string &  ex_set)
inline

Setter for extended channel chars.

Parameters
ex_setNew set of extended channel characters

Member Data Documentation

◆ fDefaultChannelChars

std::string hops::MHO_ChannelIndexLabeler::fDefaultChannelChars
protected

◆ fExtendedChannelChars

std::string hops::MHO_ChannelIndexLabeler::fExtendedChannelChars
protected

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