#include <Subscription.hpp>
Definition at line 12 of file Subscription.hpp.
msp::client::SubscriptionBase::SubscriptionBase |
( |
| ) |
|
|
inline |
virtual msp::client::SubscriptionBase::~SubscriptionBase |
( |
| ) |
|
|
inlinevirtual |
virtual void msp::client::SubscriptionBase::decode |
( |
msp::ByteVector & |
data | ) |
const |
|
pure virtual |
virtual const msp::Message& msp::client::SubscriptionBase::getMsgObject |
( |
| ) |
const |
|
pure virtual |
virtual void msp::client::SubscriptionBase::handleResponse |
( |
| ) |
const |
|
pure virtual |
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 |
void msp::client::SubscriptionBase::setTimerFrequency |
( |
const double & |
rate_hz | ) |
|
|
inline |
setTimerFrequency change the update rate of timer
- Parameters
-
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.
std::unique_ptr<PeriodicTimer> msp::client::SubscriptionBase::timer_ |
|
protected |
The documentation for this class was generated from the following file: