RTC Toolkit 5.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
rtctk::componentFramework::RepositorySubscriberIf::BatchRequest Class Reference

#include <repositorySubscriberIf.hpp>

Inheritance diagram for rtctk::componentFramework::RepositorySubscriberIf::BatchRequest:
rtctk::componentFramework::RepositoryIf::BatchRequest

Public Member Functions

SubscriptionId Subscribe (const DataPointPath &, NotifyCallbackType, ErrorCallbackType) const
 
SubscriptionId Subscribe (CallbackType, CallbackType, ErrorCallbackType) const
 
void Unsubscribe (SubscriptionId) const
 
- Public Member Functions inherited from rtctk::componentFramework::RepositoryIf::BatchRequest
virtual ~BatchRequest ()=default
 
template<typename T >
void CreateDataPoint (const DataPointPath &path, const T &initial_value, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)
 Add a request to create a new datapoint.
 
template<typename T >
void CreateDataPoint (const DataPointPath &path, const T &&initial_value, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)=delete
 Creation of datapoints from an rvalue reference is not allowed.
 
void DeleteDataPoint (const DataPointPath &path, const CallbackType &callback=nullptr)
 
void DataPointExists (const DataPointPath &path, bool &result, const CallbackType &callback=nullptr) const
 
void GetChildren (const DataPointPath &path, std::pair< PathList, PathList > &result, bool recurse=false, const CallbackType &callback=nullptr) const
 Add request to query the child datapoints and paths for a given parent path.
 
void GetChildren (const DataPointPath &path, std::pair< PathList, PathList > &&result, bool recurse=false, const CallbackType &callback=nullptr) const =delete
 Querying children with an rvalue reference for the result is not allowed.
 
template<typename T >
void ReadDataPoint (const DataPointPath &path, T &buffer, std::optional< std::reference_wrapper< MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr) const
 
template<typename T >
void ReadDataPoint (const DataPointPath &path, T &&buffer, std::optional< std::reference_wrapper< MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr) const =delete
 Reading from a datapoint into an rvalue reference is not allowed.
 
template<typename T >
void WriteDataPoint (const DataPointPath &path, const T &buffer, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)
 
template<typename T >
void WriteDataPoint (const DataPointPath &path, const T &&buffer, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)=delete
 Writing to a datapoint from an rvalue reference is not allowed.
 
template<typename T >
void PartialReadDataPoint (const DataPointPath &path, T &buffer, size_t first, size_t last, size_t d_first, std::optional< std::reference_wrapper< MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr) const
 Add request to partially read a datapoint.
 
template<typename T >
void PartialReadDataPoint (const DataPointPath &path, T &&buffer, size_t first, size_t last, size_t d_first, std::optional< std::reference_wrapper< MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr) const =delete
 Reading from a datapoint into an rvalue reference is not allowed.
 
template<typename T >
void PartialWriteDataPoint (const DataPointPath &path, const T &buffer, size_t first, size_t last, size_t d_first, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)
 
template<typename T >
void PartialWriteDataPoint (const DataPointPath &path, const T &&buffer, size_t first, size_t last, size_t d_first, std::optional< std::reference_wrapper< const MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr)=delete
 Writing to a datapoint from an rvalue reference is not allowed.
 
void ReadMetaData (const DataPointPath &path, MetaData &metadata, const CallbackType &callback=nullptr) const
 
void ReadMetaData (const DataPointPath &path, MetaData &&metadata, const CallbackType &callback=nullptr) const =delete
 Reading metadata into an rvalue reference is not allowed.
 
void WriteMetaData (const DataPointPath &path, const MetaData &metadata, const CallbackType &callback=nullptr)
 
void CreateSymlink (const DataPointPath &dp, const DataPointPath &link, const CallbackType &callback=nullptr)
 
void UpdateSymlink (const DataPointPath &dp, const DataPointPath &link, const CallbackType &callback=nullptr)
 

Additional Inherited Members

- Protected Attributes inherited from rtctk::componentFramework::RepositoryIf::BatchRequest
friend RepositoryIf
 
RequestList m_requests
 

Member Function Documentation

◆ Subscribe() [1/2]

RepositorySubscriberIf::SubscriptionId rtctk::componentFramework::RepositorySubscriberIf::BatchRequest::Subscribe ( CallbackType cb_created,
CallbackType cb_deleted,
ErrorCallbackType cb_error ) const

◆ Subscribe() [2/2]

RepositorySubscriberIf::SubscriptionId rtctk::componentFramework::RepositorySubscriberIf::BatchRequest::Subscribe ( const DataPointPath & path,
NotifyCallbackType cb1,
ErrorCallbackType cb2 ) const

◆ Unsubscribe()

void rtctk::componentFramework::RepositorySubscriberIf::BatchRequest::Unsubscribe ( SubscriptionId sub_id) const

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