A file based OLDB adapter that simulates OLDB with a local YAML file. More...

#include <fileOldbAdapter.hpp>

Inheritance diagram for rtctk::componentFramework::FileOldbAdapter:

Public Member Functions
	FileOldbAdapter ()=delete
	Do not allow construction with no arguments. More...

	FileOldbAdapter (const FileOldbAdapter &)=delete
	This class cannot be copy constructed. More...

FileOldbAdapter &	operator= (const FileOldbAdapter &)=delete
	This class cannot be copy assigned. More...

	FileOldbAdapter (FileOldbAdapter &&)=default
	The move constructor. More...

FileOldbAdapter &	operator= (FileOldbAdapter &&)=default
	The move assignment operator. More...

	FileOldbAdapter (const elt::mal::Uri &datauri)
	Constructs a file based OLDB. More...

virtual	~FileOldbAdapter ()
	Destroys the file based OLDB. More...

RepositoryIf::Response	SendSubscribeRequest (const SubscribeRequest &request) const override
	This is called to asynchronously send a subscription request for datapoints. More...

RepositoryIf::Response	SendUnsubscribeRequest (const UnsubscribeRequest &request) const override
	This is called to asynchronously send a request to unsubscribe from various notifications. More...

Public Member Functions inherited from rtctk::componentFramework::FileRepository
	FileRepository ()=delete

	FileRepository (const FileRepository &)=delete

FileRepository &	operator= (const FileRepository &)=delete

	FileRepository (const elt::mal::Uri &datauri, const int dirdepth)

virtual	~FileRepository () noexcept=default

void	CreateDataPoint (const DataPointPath &path, const std::type_info &type) override
	Creates a new datapoint in the repository with a specified type. More...

void	DeleteDataPoint (const DataPointPath &path) override
	Deletes a datapoint. More...

const std::type_info &	GetDataPointType (const DataPointPath &path) const override
	Fetches the type of the datapoint. More...

size_t	GetDataPointSize (const DataPointPath &path) const override
	Fetches the size of the datapoint's data. More...

bool	DataPointExists (const DataPointPath &path) const override
	Checks for the existence of a datapoint in the repository. More...

std::pair< PathList, PathList >	GetChildren (const DataPointPath &path) const override
	Queries the datapoints and child paths for a given path. More...

Response	SendReadRequest (const ReadRequest &request) const override
	Sends a request to read data from the repository. More...

Response	SendWriteRequest (const WriteRequest &request) override
	Sends a request to write data to the repository. More...

size_t	GetFitsWriteThreshold () const

void	SetFitsWriteThreshold (size_t value)
	Sets the threshold for storing numerical matrices and vectors in FITS files rather than the YAML file. More...

virtual void	CreateDataPoint (const DataPointPath &path, const std::type_info &type)=0
	Creates a new datapoint in the repository with a specified type. More...

template<typename T >
void	CreateDataPoint (const DataPointPath &path)
	Creates a new datapoint in the repository. More...

template<typename T >
void	CreateDataPoint (const DataPointPath &path, const T default_value)
	Creates a new datapoint in the repository and sets a default value. More...

template<>
void	CreateDataPoint (const DataPointPath &path, const char *default_value)

Public Member Functions inherited from rtctk::componentFramework::RepositoryIf
virtual	~RepositoryIf ()

template<typename T >
void	CreateDataPoint (const DataPointPath &path)
	Creates a new datapoint in the repository. More...

template<typename T >
void	CreateDataPoint (const DataPointPath &path, const T default_value)
	Creates a new datapoint in the repository and sets a default value. More...

template<typename T >
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)

template<>
void	CreateDataPoint (const DataPointPath &path, const char *default_value)

template<>
void	SetDataPoint (const DataPointPath &path, const char *value)

Public Member Functions inherited from rtctk::componentFramework::OldbIf
virtual	~OldbIf ()=default

Public Member Functions inherited from rtctk::componentFramework::RepositorySubscriberIf
virtual	~RepositorySubscriberIf ()

template<typename T , typename F >
void	Subscribe (const DataPointPath &path, T &buffer, F handler) const
	A convenience template function that will register a callback to receive new datapoint values in a synchronous manner. More...

void	Unsubscribe (const DataPointPath &path) const
	A simple convenience function that will deregister all callbacks for receiving new datapoint values. More...

Additional Inherited Members
Public Types inherited from rtctk::componentFramework::RepositoryIf
using	PathList = std::vector< DataPointPath >

Static Public Member Functions inherited from rtctk::componentFramework::OldbIf
static std::unique_ptr< OldbIf >	CreateAdapter (const elt::mal::Uri &uri)
	Factory method used to create the appropriate OLDB adapter depending on the URI scheme. More...

Detailed Description

A file based OLDB adapter that simulates OLDB with a local YAML file.

This class is used to simulate access to OLDB when it is not feasible to provide a full working OLDB and access it through OldbAdapter. Its use should be restricted to development and certain integration testing, since it is not written with scalability and performance in mind.

The data is stored to and read from a local YAML file, who's location is given as a file scheme URI. The YAML file format uses nested dictionaries to represent the hierarchical tree structure that corresponds to the datapoint paths. For example, if we have 3 datapoints, an integer with a path of "topdir/subdir/dp1", a floating point with a path of "topdir/subdir/dp2" and a string with a path of "topdir/dp3", this would correspond to the following YAML:

topdir:
    subdir:
        dp1:
            type: RtcInt32
            value: 123
        dp2:
            type: RtcFloat
            value: 4.5
    dp3:
        type: RtcString
        value: "somevalue"

As can be seen in the above example YAML, each datapoint has the fundamental data type stored under the type field and its value is found under the value field.

The allowed values for type are one of the following:

RtcBool - A boolean type corresponding to bool, i.e. can store true or false.
RtcInt32 - A 32 bit signed integer corresponding to int32_t.
RtcInt64 - A 64 bit signed integer corresponding to int64_t.
RtcFloat - A 32 bit floating-point number corresponding to float.
RtcDouble - A 64 bit floating-point number corresponding to double.
RtcString - An ASCII character string corresponding to std::string.
RtcVectorBool - A vector of boolean values corresponding to std::vector<bool>.
RtcVectorInt32 - A vector of 32 bit signed integers corresponding to std::vector<int32_t>.
RtcVectorInt64 - A vector of 64 bit signed integers corresponding to std::vector<int64_t>.
RtcVectorFloat - A vector of 32 bit floating-point numbers corresponding to std::vector<float>.
RtcVectorDouble - A vector of 64 bit floating-point numbers corresponding to std::vector<double>.
RtcVectorString - A vector of ASCII character strings corresponding to std::vector<std::string>.
RtcMatrixBool - A matrix of boolean values corresponding to MatrixBuffer<bool>.
RtcMatrixInt32 - A matrix of 32 bit signed integers corresponding to MatrixBuffer<int32_t>.
RtcMatrixInt64 - A matrix of 64 bit signed integers corresponding to MatrixBuffer<int64_t>.
RtcMatrixFloat - A matrix of 32 bit floating-point numbers corresponding to MatrixBuffer<float>.
RtcMatrixDouble - A matrix of 64 bit floating-point numbers corresponding to MatrixBuffer<double>.
RtcMatrixString - A matrix of ASCII character strings corresponding to MatrixBuffer<std::string>.

Note that vectors and matrices are both stored as lists in the YAML format. However, matrices will have the additional fields nrows and ncols set. For example:

topdir:
    matrix_datapoint:
        type: RtcMatrixFloat
        nrows: 2
        ncols: 3
        value: [1.0, 2.0, 3.0, 4.0, 5.0, 6.0]

Thread Safety: thread-safe – File based locking is used to make all read/write methods synchronous between all processes and threads, in addition to mutex locking to protect the structures of this class.

Constructor & Destructor Documentation

◆ FileOldbAdapter() [1/4]

rtctk::componentFramework::FileOldbAdapter::FileOldbAdapter ( )

delete

Do not allow construction with no arguments.

◆ FileOldbAdapter() [2/4]

rtctk::componentFramework::FileOldbAdapter::FileOldbAdapter ( const FileOldbAdapter & )

delete

This class cannot be copy constructed.

◆ FileOldbAdapter() [3/4]

rtctk::componentFramework::FileOldbAdapter::FileOldbAdapter ( FileOldbAdapter && )

default

The move constructor.

◆ FileOldbAdapter() [4/4]

rtctk::componentFramework::FileOldbAdapter::FileOldbAdapter ( const elt::mal::Uri & datauri )

explicit

Constructs a file based OLDB.

Parameters

[in] datauri The URI to the YAML file that will store the datapoints. This only accepts file scheme URIs on the local file system.

Note: If the YAML file does not yet exist, it will only be created on the first call to RepositoryIf::CreateDataPoint.

◆ ~FileOldbAdapter()

rtctk::componentFramework::FileOldbAdapter::~FileOldbAdapter ( )

virtual

Destroys the file based OLDB.

Note: The YAML file will not be deleted by destroying the FileOldbAdapter object.

Member Function Documentation

◆ operator=() [1/2]

FileOldbAdapter& rtctk::componentFramework::FileOldbAdapter::operator= ( const FileOldbAdapter & )

delete

This class cannot be copy assigned.

◆ operator=() [2/2]

FileOldbAdapter& rtctk::componentFramework::FileOldbAdapter::operator= ( FileOldbAdapter && )

default

The move assignment operator.

◆ SendSubscribeRequest()

RepositoryIf::Response rtctk::componentFramework::FileOldbAdapter::SendSubscribeRequest ( const SubscribeRequest & request ) const

overridevirtual

This is called to asynchronously send a subscription request for datapoints.

One or more datapoints can be subscribed to by constructing a SubscribeRequest object and sending it to the repository service with this method. A typical usage is indicated in the following code sample:

void OnRemoved(const DataPointPath& path) {
  ...
}
void OnNewValue(const DataPointPath& path, int64_t& buffer) {
  ...
}
 
RepositorySubscriberIf& repo = ...;
int64_t buffer = ...;
SubscribeRequest request;
request.AddRemoveHandler("/test/datapoint"_dppath, OnRemoved);
request.AddNewValueHandler("/test/datapoint"_dppath, buffer, OnNewValue);
auto response = repo.SendSubscribeRequest(request);
  ... can do some work here ...
response.Wait();

Note: One must not access the buffers added to a SubscribeRequest object once SendSubscribeRequest has been invoked. At least not without using some form of synchronisation, e.g. a mutex, since the buffers will be updated asynchronously in different threads to the one used by the caller.

Parameters

[in] request The subscription request to send to the repository.

Returns: A response object (a future) that is used to wait for completion of the request.

Thread Safety: thread-safe

Exception Safety: basic

Implements rtctk::componentFramework::RepositorySubscriberIf.

◆ SendUnsubscribeRequest()

RepositoryIf::Response rtctk::componentFramework::FileOldbAdapter::SendUnsubscribeRequest ( const UnsubscribeRequest & request ) const

overridevirtual

This is called to asynchronously send a request to unsubscribe from various notifications.

One can stop receiving notifications for one or more datapoints by constructing a UnsubscribeRequest object and sending it to the repository service with this method. A typical usage is indicated in the following code sample:

void OnRemoved(const DataPointPath& path) {
  ...
}
void OnNewValue(const DataPointPath& path, int64_t& buffer) {
  ...
}
 
RepositorySubscriberIf& repo = ...;
UnsubscribeRequest request;
request.AddRemoveHandler("/test/datapoint"_dppath);
request.AddNewValueHandler("/test/datapoint"_dppath);
auto response = repo.SendUnsubscribeRequest(request);
  ... can do some work here ...
response.Wait();

Parameters

[in] request The request to send to the repository.

Returns: A response object (a future) that is used to wait for completion of the request.

Thread Safety: thread-safe

Exception Safety: basic

Implements rtctk::componentFramework::RepositorySubscriberIf.

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

componentFramework/services/oldb/src/include/rtctk/componentFramework/fileOldbAdapter.hpp
componentFramework/services/oldb/src/fileOldbAdapter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileOldbAdapter() [1/4]

◆ FileOldbAdapter() [2/4]

◆ FileOldbAdapter() [3/4]

◆ FileOldbAdapter() [4/4]

◆ ~FileOldbAdapter()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ SendSubscribeRequest()

◆ SendUnsubscribeRequest()