ifw-slm 0.1.2
 
Loading...
Searching...
No Matches
ifw::slm::OldbInterface Class Reference

#include <oldbInterface.hpp>

Inheritance diagram for ifw::slm::OldbInterface:

Public Member Functions

 OldbInterface (const std::string &prefix="")
 
virtual ~OldbInterface ()
 
void SetNumSecondaryLoops (int num_loops)
 
void WriteSecondaryLoopConfig (const rad::Config &config)
 
void InitializeLoopRuntimeState (int loop_index)
 
template<typename T>
bool TrySetValue (const std::string &key, const T &value)
 
 OldbInterface (const OldbInterface &)=delete
 
OldbInterfaceoperator= (const OldbInterface &)=delete
 Disable copy constructor.
 

Detailed Description

This class is the interface to the CII OLDB.

Constructor & Destructor Documentation

◆ OldbInterface() [1/2]

ifw::slm::OldbInterface::OldbInterface ( const std::string & prefix = "")

Constructor.

Parameters
[in]prefixString used as prefix when building the keys.

◆ ~OldbInterface()

ifw::slm::OldbInterface::~OldbInterface ( )
virtual

Destructor

◆ OldbInterface() [2/2]

ifw::slm::OldbInterface::OldbInterface ( const OldbInterface & )
delete

Member Function Documentation

◆ InitializeLoopRuntimeState()

void ifw::slm::OldbInterface::InitializeLoopRuntimeState ( int loop_index)

Initialize runtime state for a specific loop.

Parameters
loop_indexLoop index (1-based)

◆ operator=()

OldbInterface & ifw::slm::OldbInterface::operator= ( const OldbInterface & )
delete

Disable copy constructor.

◆ SetNumSecondaryLoops()

void ifw::slm::OldbInterface::SetNumSecondaryLoops ( int num_loops)

Write the number of secondary loops to OLDB.

Parameters
num_loopsNumber of secondary loops

◆ TrySetValue()

template<typename T>
bool ifw::slm::OldbInterface::TrySetValue ( const std::string & key,
const T & value )
inline

Try to write a value to OLDB and return success/failure. This is useful for diagnosing OLDB write issues.

Parameters
keyOLDB key
valueValue to write
Template Parameters
TType of the value
Returns
true if write was successful, false otherwise

◆ WriteSecondaryLoopConfig()

void ifw::slm::OldbInterface::WriteSecondaryLoopConfig ( const rad::Config & config)

Write all secondary loop configurations from the config object to OLDB.

Parameters
configConfiguration object

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