rtctk::componentFramework::RuntimeRepoIf Class Reference

Base interface for all Runtime Configuration Repository adapters. More...

#include <rtctk/componentFramework/runtimeRepoIf.hpp>

Inheritance diagram for rtctk::componentFramework::RuntimeRepoIf:

Public Types
using	AdapterIdType = elt::mal::Uri
	The type used to distinguish between different adapters implementing RuntimeRepoIf.
Public Types inherited from rtctk::componentFramework::RepositorySubscriberIf
template<typename T>
using	ValueCallbackType = std::function<void(const DataPointPath&, T&, const MetaData&)>
using	NotifyCallbackType = std::function<void(const DataPointPath&, const MetaData&)>
using	ErrorCallbackType = std::function<void(std::exception_ptr)>
using	SubscriptionId = size_t
Public Types inherited from rtctk::componentFramework::RepositoryIf
using	PathList = std::vector<DataPointPath>
using	Clock = taiclock::TaiClock
using	Timestamp = Clock::time_point
using	CallbackType = std::function<void(const DataPointPath&)>
	Signature of the callback functions that can be registered with the repository requests.

Public Member Functions
	~RuntimeRepoIf () override=default
virtual elt::mal::Uri	GetUri () const =0
	Get the URI used when creating this adapter object.
Public Member Functions inherited from rtctk::componentFramework::RepositorySubscriberIf
	RepositorySubscriberIf ()=default
template<typename T = void, typename F>
Subscription	Subscribe (const DataPointPath &path, const F &cb_value, const ErrorCallbackType &cb_error) const
	Subscribes to datapoint values change events by registering callbacks.
Subscription	Subscribe (const CallbackType &cb_created, const CallbackType &cb_deleted, const ErrorCallbackType &cb_error) const
	Subscribes to datapoint creation and deletion events by registering callbacks.
Public Member Functions inherited from rtctk::componentFramework::RepositoryIf
	RepositoryIf ()=default
virtual	~RepositoryIf ()=default
BatchResponse	SendRequest (const BatchRequest &request)
BatchResponse	SendRequest (const BatchRequest &request) const
template<typename T>
void	CreateDataPoint (const DataPointPath &path)
	Creates a new empty datapoint in the repository.
template<typename T>
void	CreateDataPoint (const DataPointPath &path, const T &initial_value)
	Creates a new datapoint in the repository with an initial value.
void	CreateDataPoint (const DataPointPath &path, const char *initial_value)
void	DeleteDataPoint (const DataPointPath &path, bool recurse=false)
	Deletes a datapoint.
const std::type_info &	GetDataPointType (const DataPointPath &path) const
	Fetches the type of the datapoint.
size_t	GetDataPointSize (const DataPointPath &path) const
	Fetches the size of the datapoint's data.
RtcVectorUInt64	GetDataPointShape (const DataPointPath &path) const
	Fetches the shape of the datapoint's data.
bool	DataPointExists (const DataPointPath &path) const
	Checks for the existence of a datapoint in the repository.
std::pair< PathList, PathList >	GetChildren (const DataPointPath &path, bool recurse=false) const
	Queries the child datapoints and paths for a given parent path.
template<typename T>
T	GetDataPoint (const DataPointPath &path) const
	Fetches a datapoint from the repository.
template<typename T>
std::optional< T >	TryGetDataPoint (const DataPointPath &path) const
	Fetches a datapoint from the repository.
template<typename T>
void	SetDataPoint (const DataPointPath &path, const T &value)
	Sets a datapoint in the repository.
void	SetDataPoint (const DataPointPath &path, const char *value)
template<typename T>
void	ReadDataPoint (const DataPointPath &path, T &buffer) const
	Reads a datapoint from the repository.
template<typename T>
void	WriteDataPoint (const DataPointPath &path, const T &buffer)
	Writes a datapoint to the repository.
void	WriteDataPoint (const DataPointPath &path, const char *buffer)
template<typename... T>
void	WriteDataPoints (const T &... args)
template<typename... T>
void	ReadDataPoints (T &... args) const

Static Public Member Functions
static std::unique_ptr< RuntimeRepoIf >	CreateAdapter (const elt::mal::Uri &uri)
	Factory method used to create the appropriate Runtime Configuration Repository adapter depending on the URI scheme.
Static Public Member Functions inherited from rtctk::componentFramework::RepositoryIf
static const std::type_info &	StringToType (const std::string &arg)
	Converts an RTC datapoint type string to a type_info.
static std::string	TypeToString (const std::type_info &arg)
	Converts a type_info to an RTC datapoint type string.
static std::any	MakeAnyBuffer (const MetaData &metadata)
	Helper method to create an std::any buffer compatible with a specific datapoint.

Additional Inherited Members
Protected Types inherited from rtctk::componentFramework::RepositoryIf
using	RequestList = std::vector<std::any>
Protected Member Functions inherited from rtctk::componentFramework::RepositoryIf
virtual BatchResponse	ProcessRequests (const RequestList &requests)=0

Detailed Description

Base interface for all Runtime Configuration Repository adapters.

Member Typedef Documentation

AdapterIdType

using rtctk::componentFramework::RuntimeRepoIf::AdapterIdType = elt::mal::Uri

The type used to distinguish between different adapters implementing RuntimeRepoIf.

This is used to specialise the FactoryRegistry to make it suitable for adapter factories discriminated using a URI to select different backend implementations of the repository service.

Constructor & Destructor Documentation

~RuntimeRepoIf()

rtctk::componentFramework::RuntimeRepoIf::~RuntimeRepoIf ( )

overridedefault

Member Function Documentation

CreateAdapter()

std::unique_ptr< RuntimeRepoIf > rtctk::componentFramework::RuntimeRepoIf::CreateAdapter ( const elt::mal::Uri & uri )

static

Factory method used to create the appropriate Runtime Configuration Repository adapter depending on the URI scheme.

The URI schemes supported by the factory method include the following:

• rtr - Will create an instance of RuntimeRepoAdapter, to be used in operations.
• fake - Will create an instance of FakeRuntimeRepoAdapter, a simple repository suitable for testing. Need to link against the testSupport libraries for this to be available.

Parameters

[in]

uri

The URI of the repository that needs to be accessed.

Returns

A unique pointer to the newly created adapter object. The caller must clean the object up once it is no longer needed.

Exceptions

UnsupportedUriException	If the URI is not supported.
AdapterCreationException	If the factory failed to create a new instance. This will contain nested exceptions caught from the adapter class constructor.

Thread Safety

thread-safe

Exception Safety

basic

GetUri()

virtual elt::mal::Uri rtctk::componentFramework::RuntimeRepoIf::GetUri ( ) const

pure virtual

Get the URI used when creating this adapter object.

Returns

elt::mal::Uri object indicating the URI used with CreateAdapter.

Thread Safety

thread-safe

Exception Safety

strong

Implemented in rtctk::componentFramework::RuntimeRepoAdapter, rtctk::componentFramework::test::FakeRuntimeRepoIf, and rtctk::componentFramework::test::MockRuntimeRepoIf.

---

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

• componentFramework/services/runtimeRepo/src/include/rtctk/componentFramework/runtimeRepoIf.hpp
• componentFramework/services/runtimeRepo/src/runtimeRepoIf.cpp