tdaq-develop-2025-02-12
Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
ots::TableGroupKey Class Reference

#include <otsdaq/TableCore/TableGroupKey.h>

Public Member Functions

 TableGroupKey (unsigned int key=INVALID)
 
 TableGroupKey (char *const &groupString)
 groupString parameter can be the full group name, or just the group key
 
 TableGroupKey (const std::string &groupString)
 
unsigned int key (void) const
 
bool isInvalid (void) const
 isInvalid
 
std::string toString (void) const
 toString
 
std::string str () const
 alternative alias method
 
TableGroupKey & operator= (const unsigned int key)
 Operators. More...
 
bool operator== (unsigned int key) const
 operator==
 
bool operator== (const TableGroupKey &key) const
 
bool operator!= (unsigned int key) const
 
bool operator!= (const TableGroupKey &key) const
 
bool operator< (const TableGroupKey &key) const
 operator<
 
bool operator> (const TableGroupKey &key) const
 operator>
 
bool operator<= (const TableGroupKey &key) const
 
bool operator>= (const TableGroupKey &key) const
 
TableGroupKey & operator*= (const unsigned int a)
 to support StringMacros on TableGroupKey types More...
 
TableGroupKey & operator*= (const TableGroupKey a)
 to support StringMacros on TableGroupKey types More...
 
TableGroupKey & operator+= (const TableGroupKey a)
 to support StringMacros on TableGroupKey types More...
 
TableGroupKey & operator-= (const TableGroupKey a)
 to support StringMacros on TableGroupKey types More...
 
TableGroupKey & operator/= (const TableGroupKey a)
 to support StringMacros on TableGroupKey types More...
 

Static Public Member Functions

static TableGroupKey getNextKey (const TableGroupKey &key=TableGroupKey())
 
static std::string getFullGroupString (const std::string &groupName, const TableGroupKey &key, const std::string &preKey="_v", const std::string &postKey="")
 
static void getGroupNameAndKey (const std::string &fullGroupString, std::string &groupName, TableGroupKey &key)
 requires fullGroupString created as name + "_v" + key + ""
 
static unsigned int getDefaultKey (void)
 
static unsigned int getInvalidKey (void)
 

Static Public Attributes

static const unsigned int INVALID = -1
 

Friends

std::ostream & operator<< (std::ostream &out, const TableGroupKey &key)
 

Detailed Description

TableGroupKey is the type used for versions association with global configurations (whereas TableVersion is the type used for version associated with a configuration table)

Definition at line 11 of file TableGroupKey.h.

Member Function Documentation

◆ getFullGroupString()

std::string TableGroupKey::getFullGroupString ( const std::string &  groupName,
const TableGroupKey &  key,
const std::string &  preKey = "_v",
const std::string &  postKey = "" 
)
static

getGroupNameWithKey returns next key given the most recent key if given nothing returns DEFAULT as first key if given 0, returns 1, etc. if no available keys left return INVALID

Definition at line 174 of file TableGroupKey.cc.

◆ getNextKey()

TableGroupKey TableGroupKey::getNextKey ( const TableGroupKey &  key = TableGroupKey())
static

getNextKey returns next key given the most recent key if given nothing returns DEFAULT as first key if given 0, returns 1, etc. if no available keys left return INVALID

Definition at line 156 of file TableGroupKey.cc.

◆ operator*=() [1/2]

TableGroupKey & TableGroupKey::operator*= ( const TableGroupKey  a)

to support StringMacros on TableGroupKey types

operator*= Only implemented to support StringMacros on TableGroupKey types (e.g. getMapFromString in StringMacros.icc)

Definition at line 79 of file TableGroupKey.cc.

◆ operator*=() [2/2]

TableGroupKey & TableGroupKey::operator*= ( const unsigned int  a)

to support StringMacros on TableGroupKey types

operator*= Only implemented to support StringMacros on TableGroupKey types (e.g. getMapFromString in StringMacros.icc)

Definition at line 71 of file TableGroupKey.cc.

◆ operator+=()

TableGroupKey & TableGroupKey::operator+= ( const TableGroupKey  a)

to support StringMacros on TableGroupKey types

operator+= Only implemented to support StringMacros on TableGroupKey types (e.g. getMapFromString in StringMacros.icc)

Definition at line 87 of file TableGroupKey.cc.

◆ operator-=()

TableGroupKey & TableGroupKey::operator-= ( const TableGroupKey  a)

to support StringMacros on TableGroupKey types

operator+= Only implemented to support StringMacros on TableGroupKey types (e.g. getMapFromString in StringMacros.icc)

Definition at line 95 of file TableGroupKey.cc.

◆ operator/=()

TableGroupKey & TableGroupKey::operator/= ( const TableGroupKey  a)

to support StringMacros on TableGroupKey types

operator/= Only implemented to support StringMacros on TableGroupKey types (e.g. getMapFromString in StringMacros.icc)

Definition at line 103 of file TableGroupKey.cc.

◆ operator=()

TableGroupKey & TableGroupKey::operator= ( const unsigned int  key)

Operators.

assignment operator with type int

Definition at line 119 of file TableGroupKey.cc.

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