rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters Class Reference

A structure to hold the arguments passed to the Add method. More...

#include <rtctk/componentFramework/repositorySubscriberIf.hpp>

Public Types
using	CallbackType = std::function<void(const DataPointPath&)>
	callback type that is used internally

Public Member Functions
	Parameters ()=default
	Parameters (const DataPointPath &path, bool value_requested, void *buffer, const std::type_info &type, const CallbackType &removed_callback, const CallbackType &newvalue_callback)
	Allows to explicitly construct a complete parameters structure.
	Parameters (const DataPointPath &path, void *buffer, const std::type_info &type, const CallbackType &removed_callback, const CallbackType &newvalue_callback)
const DataPointPath &	GetPath () const
const bool	GetValueRequested () const
void *	GetBuffer () const
const std::type_info &	GetType () const
const CallbackType &	GetRemovedCallback () const
const CallbackType &	GetNewValueCallback () const

Detailed Description

A structure to hold the arguments passed to the Add method.

Member Typedef Documentation

CallbackType

using rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::CallbackType = std::function<void(const DataPointPath&)>

callback type that is used internally

Constructor & Destructor Documentation

Parameters() [1/3]

rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::Parameters ( )

default

Parameters() [2/3]

rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::Parameters ( const DataPointPath & path, bool value_requested, void * buffer, const std::type_info & type, const CallbackType & removed_callback, const CallbackType & newvalue_callback )

inlineexplicit

Allows to explicitly construct a complete parameters structure.

Parameters

[in]	path	The datapoint path to subscribe to.
[in]	value_requested	True if ValueSubscription, False if Notification Only.
[in]	buffer	Pointer to the data object that will be filled with new values.
[in]	type	The type of the object pointed to by buffer.
[in]	removed_callback	The callback to invoke when a datapoint is deleted. This can be nullptr to indicate no callback is registered.
[in]	newvalue_callback	The callback to invoke when a datapoint is update with a new value. This can be nullptr to indicate no callback is registered.

Parameters() [3/3]

rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::Parameters ( const DataPointPath & path, void * buffer, const std::type_info & type, const CallbackType & removed_callback, const CallbackType & newvalue_callback )

inlineexplicit

Member Function Documentation

GetBuffer()

void * rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetBuffer ( ) const

inline

GetNewValueCallback()

const CallbackType & rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetNewValueCallback ( ) const

inline

GetPath()

const DataPointPath & rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetPath ( ) const

inline

GetRemovedCallback()

const CallbackType & rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetRemovedCallback ( ) const

inline

GetType()

const std::type_info & rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetType ( ) const

inline

GetValueRequested()

const bool rtctk::componentFramework::RepositorySubscriberIf::SubscribeRequest::Parameters::GetValueRequested ( ) const

inline

---

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

• componentFramework/services/common/src/include/rtctk/componentFramework/repositorySubscriberIf.hpp