RTC Toolkit  0.1.0-alpha
Public Member Functions | List of all members
rtctk::componentFramework::RuntimeRepoApiIf Class Referenceabstract

#include <runtimeRepoApiIf.hpp>

Inheritance diagram for rtctk::componentFramework::RuntimeRepoApiIf:
rtctk::componentFramework::RepositoryIf MockRuntimeRepo rtctk::componentFramework::FakeRuntimeRepoAdapter rtctk::componentFramework::RuntimeRepoAdapter

Public Member Functions

virtual ~RuntimeRepoApiIf ()
 
virtual void Subscribe (const Subscription &subscription) const =0
 
virtual void Unsubscribe (const Subscription &subscription) const =0
 
- Public Member Functions inherited from rtctk::componentFramework::RepositoryIf
virtual ~RepositoryIf ()
 
virtual void CreateDataPoint (const DataPointPath &path, const std::string &type)=0
 Creates a new datapoint in the repository with a specified type. More...
 
template<typename T >
void CreateDataPointV2 (const DataPointPath &path)
 Creates a new datapoint in the repository. More...
 
template<typename T >
void CreateDataPointV2 (const DataPointPath &path, const T default_value)
 Creates a new datapoint in the repository and sets a default value. More...
 
virtual void DeleteDataPoint (const DataPointPath &path)=0
 Deletes a datapoint. More...
 
virtual std::string GetDataPointType (const DataPointPath &path) const =0
 Fetches the type of the datapoint. More...
 
virtual size_t GetDataPointSize (const DataPointPath &path) const =0
 Fetches the size of the datapoint's data. More...
 
virtual bool DataPointExists (const DataPointPath &path) const =0
 Checks for the existence of a datapoint in the repository. More...
 
virtual std::pair< StringList, StringListGetChildren (const DataPointPath &path) const =0
 Queries the datapoints and child paths for a given path. More...
 
template<typename T >
GetDataPoint (const DataPointPath &path) const
 Fetches a datapoint from the repository. More...
 
template<typename T >
void SetDataPoint (const DataPointPath &path, const T value)
 Sets a datapoint in the repository. More...
 
template<typename T >
void ReadDataPoint (const DataPointPath &path, T &buffer) const
 Reads a datapoint from the repository. More...
 
template<typename T >
void WriteDataPoint (const DataPointPath &path, const T &buffer)
 Writes a datapoint to the repository. More...
 
void WriteDataPoint (const DataPointPath &path, const char *buffer)
 
virtual Response SendReadRequest (const Request &request) const =0
 Sends a request to read data from the repository. More...
 
virtual Response SendWriteRequest (const Request &request)=0
 Sends a request to write data to the repository. More...
 
template<>
void CreateDataPointV2 (const DataPointPath &path, const char *default_value)
 
template<>
void SetDataPoint (const DataPointPath &path, const char *value)
 

Additional Inherited Members

- Public Types inherited from rtctk::componentFramework::RepositoryIf
using StringList = std::vector< std::string >
 

Constructor & Destructor Documentation

◆ ~RuntimeRepoApiIf()

rtctk::componentFramework::RuntimeRepoApiIf::~RuntimeRepoApiIf ( )
virtual

Default destructor to make sure it is virtual.

Member Function Documentation

◆ Subscribe()

virtual void rtctk::componentFramework::RuntimeRepoApiIf::Subscribe ( const Subscription subscription) const
pure virtual

◆ Unsubscribe()

virtual void rtctk::componentFramework::RuntimeRepoApiIf::Unsubscribe ( const Subscription subscription) const
pure virtual

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