Implements a file based repository that stores datapoints in local YAML and FITS files. More...

#include <fileRepository.hpp>

Inheritance diagram for rtctk::componentFramework::FileRepository:

Public Member Functions
	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)

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

Detailed Description

Implements a file based repository that stores datapoints in local YAML and FITS files.

This class is used to implement file based versions of adapters deriving from RepositoryIf. Such adapters are normally used for testing purposes.

Thread Safety: thread-safe – In addition to the class being thread safe, the functions that read or write to the file system will take a file lock to protect against concurrent read/write operations.

Note: The class's attributes are protected using a mutex. All accesses to the attribute memory structures are serialised. However, the access to the files on disk are performed to adhere to single writer, multiple reader semantics. Therefore all method calls that modify the YAML or FITS files use a file lock to serialise the access. While methods that only read the files do not use a lock. To ensure data consistency between reads and writes, the write operations are first performed to a new file, leaving the old one in place. Once the new file is written, the old file is replaced by the new file in an atomic manner by renaming it. Any new read operations will see the new data after the renaming. The filesystem itself will only actually delete the old file once the last pending read operation started before the rename is complete.

Constructor & Destructor Documentation

◆ FileRepository() [1/3]

rtctk::componentFramework::FileRepository::FileRepository ( )

delete

◆ FileRepository() [2/3]

rtctk::componentFramework::FileRepository::FileRepository ( const FileRepository & )

delete

◆ FileRepository() [3/3]

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

explicit

◆ ~FileRepository()

virtual rtctk::componentFramework::FileRepository::~FileRepository ( )

virtualdefaultnoexcept

Member Function Documentation

◆ CreateDataPoint() [1/5]

template<typename T >

void rtctk::componentFramework::RepositoryIf::CreateDataPoint ( typename T )

Creates a new datapoint in the repository.

The type of the datapoint is derived from the template argument type.

Template Parameters

T	The type of the datapoint to create.

Parameters

[in] path The datapoint path that should be created.

Thread Safety: thread-safe

Exception Safety: basic

◆ CreateDataPoint() [2/5]

template<>

void rtctk::componentFramework::RepositoryIf::CreateDataPoint ( )

◆ CreateDataPoint() [3/5]

void rtctk::componentFramework::FileRepository::CreateDataPoint	(	const DataPointPath &	path,
		const std::type_info &	type
	)

overridevirtual

Creates a new datapoint in the repository with a specified type.

Parameters

[in]	path	The datapoint path that should be created.
[in]	type	A type identifier object returned by `typeid` indicating the type of the new datapoint. Supported values are indicated below.

The following are the supported values for the type argument:

typeid(bool)
typeid(int32_t)
typeid(int64_t)
typeid(float)
typeid(double)
typeid(std::string)
typeid(std::vector<bool>)
typeid(std::vector<int32_t>)
typeid(std::vector<int64_t>)
typeid(std::vector<float>)
typeid(std::vector<double>)
typeid(std::vector<std::string>)
typeid(MatrixBuffer<bool>)
typeid(MatrixBuffer<int32_t>)
typeid(MatrixBuffer<int64_t>)
typeid(MatrixBuffer<float>)
typeid(MatrixBuffer<double>)
typeid(MatrixBuffer<std::string>)

Thread Safety: thread-safe

Exception Safety: basic

Implements rtctk::componentFramework::RepositoryIf.

◆ CreateDataPoint() [4/5]

virtual void rtctk::componentFramework::RepositoryIf::CreateDataPoint

Creates a new datapoint in the repository with a specified type.

Parameters

[in]	path	The datapoint path that should be created.
[in]	type	A type identifier object returned by `typeid` indicating the type of the new datapoint. Supported values are indicated below.

The following are the supported values for the type argument:

typeid(bool)
typeid(int32_t)
typeid(int64_t)
typeid(float)
typeid(double)
typeid(std::string)
typeid(std::vector<bool>)
typeid(std::vector<int32_t>)
typeid(std::vector<int64_t>)
typeid(std::vector<float>)
typeid(std::vector<double>)
typeid(std::vector<std::string>)
typeid(MatrixBuffer<bool>)
typeid(MatrixBuffer<int32_t>)
typeid(MatrixBuffer<int64_t>)
typeid(MatrixBuffer<float>)
typeid(MatrixBuffer<double>)
typeid(MatrixBuffer<std::string>)

Thread Safety: thread-safe

Exception Safety: basic

◆ CreateDataPoint() [5/5]

template<typename T >

void rtctk::componentFramework::RepositoryIf::CreateDataPoint ( typename T )

Creates a new datapoint in the repository and sets a default value.

The type of the datapoint is derived from the template argument type.

Template Parameters

T	The type of the datapoint to create.

Parameters

[in]	path	The datapoint path that should be created.
[in]	default_value	The default value that should be set for the new datapoint.

Thread Safety: thread-safe

Exception Safety: basic

◆ DataPointExists()

bool rtctk::componentFramework::FileRepository::DataPointExists ( const DataPointPath & path ) const

overridevirtual

Checks for the existence of a datapoint in the repository.

Parameters

[in] path The datapoint path to check.

Returns: true if the datapoint path exists in the repository and false otherwise.

Thread Safety: thread-safe

Exception Safety: strong

Implements rtctk::componentFramework::RepositoryIf.

◆ DeleteDataPoint()

void rtctk::componentFramework::FileRepository::DeleteDataPoint ( const DataPointPath & path )

overridevirtual

Deletes a datapoint.

Parameters

[in] path The path of the datapoint to delete in the repository.

Thread Safety: thread-safe

Exception Safety: basic

Implements rtctk::componentFramework::RepositoryIf.

◆ GetChildren()

std::pair< FileRepository::PathList, FileRepository::PathList > rtctk::componentFramework::FileRepository::GetChildren ( const DataPointPath & path ) const

overridevirtual

Queries the datapoints and child paths for a given path.

This method will query all the available datapoints that are leaf nodes immediately below the given path and also the child paths, i.e. sub-folders when interpreting the repository as a hierarchical folder like structure. The set of immediate datapoint and child paths is returned as two separate lists.

If an error occurs when querying the the repository a rtctk::componentFramework::RtctkException is thrown.

Parameters

[in] path The path in which to search for datapoints and child paths.

Returns: A std::pair of path lists, i.e. std::vector<DataPointPath>, with the first list in the pair containing the datapoints found and the second list containing the child paths found. If no datapoints are found then the list for datapoints is empty. Similarly if not child paths are found then the child path list is empty.

Thread Safety: thread-safe

Exception Safety: strong

Implements rtctk::componentFramework::RepositoryIf.

◆ GetDataPointSize()

size_t rtctk::componentFramework::FileRepository::GetDataPointSize ( const DataPointPath & path ) const

overridevirtual

Fetches the size of the datapoint's data.

This method will return one of the following values depending on the category of the datapoint's type:

Scalars: Will always return 1 for scalars such as RtcBool, RtcInt32, RtcInt64, RtcFloat, and RtcDouble.
Strings: Will return the length of the string, i.e. the number of characters in the string.
Vectors: Will return the number of elements in the vector.
Matrices: Will return the total number of elements in the matrix, i.e. the number of rows times the number of columns.

Returns: The number of elements in the datapoint's data.

Thread Safety: thread-safe

Exception Safety: strong

Implements rtctk::componentFramework::RepositoryIf.

◆ GetDataPointType()

const std::type_info & rtctk::componentFramework::FileRepository::GetDataPointType ( const DataPointPath & path ) const

overridevirtual

Fetches the type of the datapoint.

This will return the type used when the datapoint was created with the CreateDataPoint method.

Returns: The type_info object corresponding to the type of the datapoint.

Thread Safety: thread-safe

Exception Safety: strong

Implements rtctk::componentFramework::RepositoryIf.

◆ GetFitsWriteThreshold()

size_t rtctk::componentFramework::FileRepository::GetFitsWriteThreshold ( ) const

inline

Returns: The number of matrix or vector elements above which numerical matrices and vectors are stored in FITS files rather than the YAML file.

Thread Safety: thread-safe

Exception Safety: basic

◆ operator=()

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

delete

◆ SendReadRequest()

Response rtctk::componentFramework::FileRepository::SendReadRequest ( const ReadRequest & request ) const

overridevirtual

Sends a request to read data from the repository.

This method allows non-blocking and asynchronous reading of datapoints form the repository. The method returns immediately, allowing other work to be done in the calling thread while the read request is completed in the background. If any callback handlers were registered in request, they will be called as soon as the data is available for the respective datapoint.

Note: The buffers for the datapoints added to request must not be accessed until the Wait method of the response object returns successfully, i.e. without a timeout.

If an error occurs then a rtctk::componentFramework::RtctkException is thrown.

Note: This method is not transactional or fully atomic. If an error occurs while reading the datapoints, some or all of the datapoint buffers registered with the read request may be left unmodified. It is however guaranteed that any particular datapoint buffer is either updated completely or not modified at all.

Parameters

[in] request The request object that contains all the datapoints to read.

Returns: A response object that must be used to synchronise with the completion of the read request.

Implements rtctk::componentFramework::RepositoryIf.

◆ SendWriteRequest()

Response rtctk::componentFramework::FileRepository::SendWriteRequest ( const WriteRequest & request )

overridevirtual

Sends a request to write data to the repository.

This method allows non-blocking writing of datapoints to the repository. The method returns immediately, allowing other work to be done in the calling thread while the write request is completed in the background. If any callback handlers were registered in request, they will be called as soon as the respective datapoint's data has been sent and the buffer will no longer be accessed by the API, i.e. the caller can modify or release the buffer from that point on.

Note: The buffers for the datapoints added to request must not be modified or released until the Wait method of the response object returns successfully, i.e. without a timeout.

If an error occurs then a rtctk::componentFramework::RtctkException is thrown.

Note: This method is not transactional or fully atomic. If an error occurs while writing the datapoints, only some of the datapoints registered with the write request may be actually updated in the repository. It is however guaranteed that any particular datapoint is either updated completely in the repository or not at all.

Parameters

[in] request The request object that contains all the datapoints to write.

Returns: A response object that must be used to synchronise with the completion of the write request.

Implements rtctk::componentFramework::RepositoryIf.

◆ SetFitsWriteThreshold()

void rtctk::componentFramework::FileRepository::SetFitsWriteThreshold ( size_t value )

inline

Sets the threshold for storing numerical matrices and vectors in FITS files rather than the YAML file.

Parameters

[in] value The minimum number of elements a matrix/vector must have to store it to a FITS files. If this is set to zero then matrices and vectors are always stored in FITS files.

Thread Safety: thread-safe

Exception Safety: basic

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

componentFramework/services/common/src/include/rtctk/componentFramework/fileRepository.hpp
componentFramework/services/common/src/fileRepository.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileRepository() [1/3]

◆ FileRepository() [2/3]

◆ FileRepository() [3/3]

◆ ~FileRepository()

Member Function Documentation

◆ CreateDataPoint() [1/5]

◆ CreateDataPoint() [2/5]

◆ CreateDataPoint() [3/5]

◆ CreateDataPoint() [4/5]

◆ CreateDataPoint() [5/5]

◆ DataPointExists()

◆ DeleteDataPoint()

◆ GetChildren()

◆ GetDataPointSize()

◆ GetDataPointType()

◆ GetFitsWriteThreshold()

◆ operator=()

◆ SendReadRequest()

◆ SendWriteRequest()

◆ SetFitsWriteThreshold()