rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::Parameters Class Reference

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

#include <rtctk/componentFramework/repositorySubscriberIf.hpp>

Public Member Functions
	Parameters ()=default
	Parameters (const DataPointPath &path, const bool unsubscribe_removed, const bool unsubscribe_newvalue)
	Allows to explicitly construct a complete parameters structure.
const DataPointPath &	GetPath () const
bool	GetUnsubscribeRemoved () const
bool	GetUnsubscribeNewValue () const

Detailed Description

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

Constructor & Destructor Documentation

Parameters() [1/2]

rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::Parameters::Parameters ( )

default

Parameters() [2/2]

rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::Parameters::Parameters ( const DataPointPath & path, const bool unsubscribe_removed, const bool unsubscribe_newvalue )

inlineexplicit

Allows to explicitly construct a complete parameters structure.

Parameters

[in]	path	The datapoint path to unsubscribe from.
[in]	unsubscribe_removed	Boolean flag indicating if the datapoint removal notification should be unsubscribed from.
[in]	unsubscribe_newvalue	Boolean flag indicating if the new datapoint value notification should be unsubscribed from.

Member Function Documentation

GetPath()

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

inline

GetUnsubscribeNewValue()

bool rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::Parameters::GetUnsubscribeNewValue ( ) const

inline

GetUnsubscribeRemoved()

bool rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::Parameters::GetUnsubscribeRemoved ( ) const

inline

---

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

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