msp::client::SubscriptionBase Class Reference

#include <Subscription.hpp>

Inheritance diagram for msp::client::SubscriptionBase:

List of all members.

Public Member Functions
virtual void	decode (msp::ByteVector &data) const =0
virtual const msp::Message &	getMsgObject () const =0
virtual void	handleResponse () const =0
bool	hasTimer () const
	Checks to see if the timer has been created.
bool	isAutomatic () const
	Checks to see if the subscription fires automatically.
virtual void	makeRequest () const =0
void	setTimerFrequency (const double &rate_hz)
	setTimerFrequency change the update rate of timer
void	setTimerPeriod (const double &period_seconds)
	setTimerPeriod change the period of the timer
bool	start () const
	Start the timer for automatic execution.
bool	stop () const
	Stop the timer's automatic execution.
	SubscriptionBase ()
virtual	~SubscriptionBase ()
Protected Attributes
std::unique_ptr< PeriodicTimer >	timer_

---

Detailed Description

Definition at line 12 of file Subscription.hpp.

---

Constructor & Destructor Documentation

msp::client::SubscriptionBase::SubscriptionBase

(

)

[inline]

Definition at line 14 of file Subscription.hpp.

virtual msp::client::SubscriptionBase::~SubscriptionBase

(

)

[inline, virtual]

Definition at line 16 of file Subscription.hpp.

---

Member Function Documentation

virtual void msp::client::SubscriptionBase::decode

(

msp::ByteVector &

data

)

const [pure virtual]

Implemented in msp::client::Subscription< T >.

virtual const msp::Message& msp::client::SubscriptionBase::getMsgObject

(

)

const [pure virtual]

Implemented in msp::client::Subscription< T >.

virtual void msp::client::SubscriptionBase::handleResponse

(

)

const [pure virtual]

Implemented in msp::client::Subscription< T >.

bool msp::client::SubscriptionBase::hasTimer

(

)

const [inline]

Checks to see if the timer has been created.

Returns:

True if there is a timer

Definition at line 38 of file Subscription.hpp.

bool msp::client::SubscriptionBase::isAutomatic

(

)

const [inline]

Checks to see if the subscription fires automatically.

Returns:

True if the request happens automatically

Definition at line 30 of file Subscription.hpp.

virtual void msp::client::SubscriptionBase::makeRequest

(

)

const [pure virtual]

Implemented in msp::client::Subscription< T >.

void msp::client::SubscriptionBase::setTimerFrequency

(

const double &

rate_hz

)

[inline]

setTimerFrequency change the update rate of timer

Parameters:

rate_hz

frequency in Hz

Definition at line 72 of file Subscription.hpp.

void msp::client::SubscriptionBase::setTimerPeriod

(

const double &

period_seconds

)

[inline]

setTimerPeriod change the period of the timer

Parameters:

period_seconds

period in seconds

Definition at line 56 of file Subscription.hpp.

bool msp::client::SubscriptionBase::start

(

)

const [inline]

Start the timer for automatic execution.

Returns:

True if the timer starts successfully

Definition at line 44 of file Subscription.hpp.

bool msp::client::SubscriptionBase::stop

(

)

const [inline]

Stop the timer's automatic execution.

Returns:

True if the timer stops successfully

Definition at line 50 of file Subscription.hpp.

---

Member Data Documentation

std::unique_ptr<PeriodicTimer> msp::client::SubscriptionBase::timer_ [protected]

Definition at line 85 of file Subscription.hpp.

---

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

• Subscription.hpp