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

A structure to hold the arguments passed with one of the Add methods. More...

#include <rtctk/componentFramework/repositoryIf.hpp>

Public Member Functions

 Parameters ()=default
 
 Parameters (const DataPointPath &path, void *buffer, const std::type_info &type, const std::function< void()> &callback)
 Allows to explicitly construct a complete parameters structure.
 
const DataPointPathGetPath () const
 
voidGetBuffer () const
 
const std::type_info & GetType () const
 
const std::function< void()> & GetCallback () const
 

Detailed Description

A structure to hold the arguments passed with one of the Add methods.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

◆ Parameters() [2/2]

rtctk::componentFramework::RepositoryIf::ReadRequest::Parameters::Parameters ( const DataPointPath & path,
void * buffer,
const std::type_info & type,
const std::function< void()> & callback )
inlineexplicit

Allows to explicitly construct a complete parameters structure.

Parameters
[in]pathThe datapoint path to read.
[in]bufferPointer to the data object that will be filled with the read data.
[in]typeThe type of the object pointed to by buffer.
[in]callbackThe callback function to invoke once the buffer is filled.

Member Function Documentation

◆ GetBuffer()

void * rtctk::componentFramework::RepositoryIf::ReadRequest::Parameters::GetBuffer ( ) const
inline

◆ GetCallback()

const std::function< void()> & rtctk::componentFramework::RepositoryIf::ReadRequest::Parameters::GetCallback ( ) const
inline

◆ GetPath()

const DataPointPath & rtctk::componentFramework::RepositoryIf::ReadRequest::Parameters::GetPath ( ) const
inline

◆ GetType()

const std::type_info & rtctk::componentFramework::RepositoryIf::ReadRequest::Parameters::GetType ( ) const
inline

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