Implementation of an in-memory fake repository for testing. More...

#include <rtctk/componentFramework/test/fakeRepository.hpp>

Inheritance diagram for rtctk::componentFramework::test::FakeRepository:

Classes
struct	Data

Public Member Functions
	FakeRepository ()

virtual	~FakeRepository ()

template<typename T >
Lut::TableEntries	BindTypeHandlers ()

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 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 >
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

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

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

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

Protected Member Functions
template<typename T >
void	CreateImpl (detail::CreateRequest< T > &req)

template<typename T >
void	ReadImpl (detail::ReadRequest< T > &req)

template<typename T >
void	WriteImpl (detail::WriteRequest< T > &req)

template<typename T >
void	PartialReadImpl (detail::PartialReadRequest< T > &req)

template<typename T >
void	PartialWriteImpl (detail::PartialWriteRequest< T > &req)

void	ReadMetaDataImpl (detail::ReadMetaDataRequest &req)

void	WriteMetaDataImpl (detail::WriteMetaDataRequest &req)

void	DeleteImpl (detail::DeleteRequest &req)

void	ExistsImpl (detail::ExistsRequest &req)

std::pair< PathList, PathList >	GetChildrenImpl (const DataPointPath &path)

std::pair< PathList, PathList >	GetChildrenRecursive (const DataPointPath &path)

void	GetChildrenImpl (detail::GetChildrenRequest &req)

void	CreateLinkImpl (detail::CreateSymlinkRequest &req)

void	UpdateLinkImpl (detail::UpdateSymlinkRequest &req)

template<typename Request >
void	InvokeCallback (const Request &req) const

template<typename T >
void	ReadData (Data &data_node, const DataPointPath &path, gsl::span< T > &data, std::optional< std::reference_wrapper< MetaData > > &metadata, size_t offset)

template<typename T >
void	WriteData (const DataPointPath &path, const gsl::span< const T > &data, const MetaData &metadata, size_t offset)

void	ReadMetaData (const DataPointPath &path, MetaData &metadata, bool check_sequence_id=false)

void	WriteMetaData (Data &data_node, const MetaData &metadata)

DataPointPath	ResolvePath (const DataPointPath &path)

Data &	CreateNewDataNode (const DataPointPath &path)

Data &	GetDataNode (const DataPointPath &path)

void	CheckDataNodeExists (const DataPointPath &path)

virtual void	InvokeRequestHandler (std::any &request)

BatchResponse	ProcessRequests (const RequestList &requests) override

Protected Member Functions inherited from rtctk::componentFramework::RepositoryIf
virtual void	DeleteDataPointLegacy (const DataPointPath &path)
	Deletes a datapoint.

virtual const std::type_info &	GetDataPointTypeLegacy (const DataPointPath &path) const
	Fetches the type of the datapoint.

virtual size_t	GetDataPointSizeLegacy (const DataPointPath &path) const
	Fetches the size of the datapoint's data.

virtual bool	DataPointExistsLegacy (const DataPointPath &path) const
	Checks for the existence of a datapoint in the repository.

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

Static Protected Member Functions
template<typename T >
static RequestDispatcher< FakeRepository >::TableEntries	BindTypeHandlers ()

Protected Attributes
std::mutex	m_mutex
	Mutex for synchronising access to m_data.

std::map< DataPointPath, Data >	m_data

Static Protected Attributes
static const RequestDispatcher< FakeRepository >	S_REQUEST_DISPATCHER

Additional Inherited Members
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.

Static Public Member Functions inherited from rtctk::componentFramework::RepositoryIf
static const std::type_info &	StringToType (const std::string &arg)
	Converts an RTC type string to a type_info.

static std::string	TypeToString (const std::type_info &arg)
	Converts a type_info to an RTC type string.

Protected Types inherited from rtctk::componentFramework::RepositoryIf
using	RequestList = std::vector<std::any>

Detailed Description

Implementation of an in-memory fake repository for testing.

Constructor & Destructor Documentation

◆ FakeRepository()

rtctk::componentFramework::test::FakeRepository::FakeRepository ( )

◆ ~FakeRepository()

rtctk::componentFramework::test::FakeRepository::~FakeRepository ( )

virtual

Member Function Documentation

◆ BindTypeHandlers() [1/2]

template<typename T >

Lut::TableEntries rtctk::componentFramework::test::FakeRepository::BindTypeHandlers ( )

◆ BindTypeHandlers() [2/2]

template<typename T >

static RequestDispatcher< FakeRepository >::TableEntries rtctk::componentFramework::test::FakeRepository::BindTypeHandlers ( )

staticprotected

◆ CheckDataNodeExists()

void rtctk::componentFramework::test::FakeRepository::CheckDataNodeExists ( const DataPointPath & path )

protected

◆ CreateImpl()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::CreateImpl ( detail::CreateRequest< T > & req )

protected

◆ CreateLinkImpl()

void rtctk::componentFramework::test::FakeRepository::CreateLinkImpl ( detail::CreateSymlinkRequest & req )

protected

◆ CreateNewDataNode()

FakeRepository::Data & rtctk::componentFramework::test::FakeRepository::CreateNewDataNode ( const DataPointPath & path )

protected

◆ DeleteImpl()

void rtctk::componentFramework::test::FakeRepository::DeleteImpl ( detail::DeleteRequest & req )

protected

◆ ExistsImpl()

void rtctk::componentFramework::test::FakeRepository::ExistsImpl ( detail::ExistsRequest & req )

protected

◆ GetChildrenImpl() [1/2]

auto rtctk::componentFramework::test::FakeRepository::GetChildrenImpl ( const DataPointPath & path )

protected

◆ GetChildrenImpl() [2/2]

void rtctk::componentFramework::test::FakeRepository::GetChildrenImpl ( detail::GetChildrenRequest & req )

protected

◆ GetChildrenRecursive()

auto rtctk::componentFramework::test::FakeRepository::GetChildrenRecursive ( const DataPointPath & path )

protected

◆ GetDataNode()

FakeRepository::Data & rtctk::componentFramework::test::FakeRepository::GetDataNode ( const DataPointPath & path )

protected

◆ InvokeCallback()

template<typename Request >

void rtctk::componentFramework::test::FakeRepository::InvokeCallback ( const Request & req ) const

protected

◆ InvokeRequestHandler()

void rtctk::componentFramework::test::FakeRepository::InvokeRequestHandler ( std::any & request )

protectedvirtual

Reimplemented in rtctk::componentFramework::test::FakeRepositorySubscriber.

◆ PartialReadImpl()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::PartialReadImpl ( detail::PartialReadRequest< T > & req )

protected

◆ PartialWriteImpl()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::PartialWriteImpl ( detail::PartialWriteRequest< T > & req )

protected

◆ ProcessRequests()

RepositoryIf::BatchResponse rtctk::componentFramework::test::FakeRepository::ProcessRequests ( const RequestList & requests )

overrideprotectedvirtual

Implements rtctk::componentFramework::RepositoryIf.

Reimplemented in rtctk::componentFramework::test::MockRepository, and rtctk::componentFramework::test::MockRuntimeRepoIf.

◆ ReadData()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::ReadData	(	Data &	data_node,
		const DataPointPath &	path,
		gsl::span< T > &	data,
		std::optional< std::reference_wrapper< MetaData > > &	metadata,
		size_t	offset )

protected

◆ ReadImpl()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::ReadImpl ( detail::ReadRequest< T > & req )

protected

◆ ReadMetaData()

void rtctk::componentFramework::test::FakeRepository::ReadMetaData	(	const DataPointPath &	path,
		MetaData &	metadata,
		bool	check_sequence_id = false )

protected

◆ ReadMetaDataImpl()

void rtctk::componentFramework::test::FakeRepository::ReadMetaDataImpl ( detail::ReadMetaDataRequest & req )

protected

◆ ResolvePath()

DataPointPath rtctk::componentFramework::test::FakeRepository::ResolvePath ( const DataPointPath & path )

protected

◆ UpdateLinkImpl()

void rtctk::componentFramework::test::FakeRepository::UpdateLinkImpl ( detail::UpdateSymlinkRequest & req )

protected

◆ WriteData()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::WriteData	(	const DataPointPath &	path,
		const gsl::span< const T > &	data,
		const MetaData &	metadata,
		size_t	offset )

protected

◆ WriteImpl()

template<typename T >

void rtctk::componentFramework::test::FakeRepository::WriteImpl ( detail::WriteRequest< T > & req )

protected

◆ WriteMetaData()

void rtctk::componentFramework::test::FakeRepository::WriteMetaData	(	Data &	data_node,
		const MetaData &	metadata )

protected

◆ WriteMetaDataImpl()

void rtctk::componentFramework::test::FakeRepository::WriteMetaDataImpl ( detail::WriteMetaDataRequest & req )

protected

Member Data Documentation

◆ m_data

std::map<DataPointPath, Data> rtctk::componentFramework::test::FakeRepository::m_data

protected

◆ m_mutex

std::mutex rtctk::componentFramework::test::FakeRepository::m_mutex

mutableprotected

Mutex for synchronising access to m_data.

◆ S_REQUEST_DISPATCHER

const Lut rtctk::componentFramework::test::FakeRepository::S_REQUEST_DISPATCHER

staticprotected

Initial value:

= {BindTypeHandlers<std::byte>(),
                                                  BindTypeHandlers<char>(),
                                                  BindTypeHandlers<RtcBool>(),
                                                  BindTypeHandlers<RtcInt8>(),
                                                  BindTypeHandlers<RtcInt16>(),
                                                  BindTypeHandlers<RtcInt32>(),
                                                  BindTypeHandlers<RtcInt64>(),
                                                  BindTypeHandlers<RtcUInt8>(),
                                                  BindTypeHandlers<RtcUInt16>(),
                                                  BindTypeHandlers<RtcUInt32>(),
                                                  BindTypeHandlers<RtcUInt64>(),
                                                  BindTypeHandlers<RtcFloat>(),
                                                  BindTypeHandlers<RtcDouble>(),
                                                  BindTypeHandlers<RtcString>(),
                                                  Lut::Bind(&FakeRepository::ReadMetaDataImpl),
                                                  Lut::Bind(&FakeRepository::WriteMetaDataImpl),
                                                  Lut::Bind(&FakeRepository::DeleteImpl),
                                                  Lut::Bind(&FakeRepository::ExistsImpl),
                                                  Lut::Bind(&FakeRepository::GetChildrenImpl),
                                                  Lut::Bind(&FakeRepository::CreateLinkImpl),
                                                  Lut::Bind(&FakeRepository::UpdateLinkImpl)}

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

componentFramework/services/testSupport/common/src/include/rtctk/componentFramework/test/fakeRepository.hpp
componentFramework/services/testSupport/common/src/fakeRepository.cpp

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FakeRepository()

◆ ~FakeRepository()

Member Function Documentation

◆ BindTypeHandlers() [1/2]

◆ BindTypeHandlers() [2/2]

◆ CheckDataNodeExists()

◆ CreateImpl()

◆ CreateLinkImpl()

◆ CreateNewDataNode()

◆ DeleteImpl()

◆ ExistsImpl()

◆ GetChildrenImpl() [1/2]

◆ GetChildrenImpl() [2/2]

◆ GetChildrenRecursive()

◆ GetDataNode()

◆ InvokeCallback()

◆ InvokeRequestHandler()

◆ PartialReadImpl()

◆ PartialWriteImpl()

◆ ProcessRequests()

◆ ReadData()

◆ ReadImpl()

◆ ReadMetaData()

◆ ReadMetaDataImpl()

◆ ResolvePath()

◆ UpdateLinkImpl()

◆ WriteData()

◆ WriteImpl()

◆ WriteMetaData()

◆ WriteMetaDataImpl()

Member Data Documentation

◆ m_data

◆ m_mutex

◆ S_REQUEST_DISPATCHER