BAOS SDK  18.2.0
Public Types | Public Member Functions | List of all members
kdrive::baos::BaosTimers Class Reference

BaosTimers is used to get/set the timer parameters from/on the remote device. More...

#include <BaosTimers.h>

Public Types

using Timers = std::vector< Timer >
 

Public Member Functions

 BaosTimers (std::shared_ptr< BaosConnector > connector)
 Creates a BaosTimers object with a specified connector. More...
 
 ~BaosTimers ()
 Destroys the BaosTimers. More...
 
Timer getTimer (unsigned int id)
 Gets the time with id. More...
 
Timers getTimers ()
 Gets the timers from the baos device Does not locally cache them. More...
 
void setTimer (const Timer &timer)
 Sets a single timer. More...
 
void setTimers (const Timers &timers)
 Sets multiple timers. More...
 
void deleteTimer (unsigned short id)
 Deletes a single timer. More...
 
void deleteTimers (const Timers &timers)
 Deletes multiple timers. More...
 

Detailed Description

BaosTimers is used to get/set the timer parameters from/on the remote device.

It wraps the GetTimer and SetTimer services,

Member Typedef Documentation

Constructor & Destructor Documentation

BaosTimers::BaosTimers ( std::shared_ptr< BaosConnector connector)

Creates a BaosTimers object with a specified connector.

precondition: connector is not null

BaosTimers::~BaosTimers ( )

Destroys the BaosTimers.

Member Function Documentation

void BaosTimers::deleteTimer ( unsigned short  id)

Deletes a single timer.

void BaosTimers::deleteTimers ( const Timers timers)

Deletes multiple timers.

Timer BaosTimers::getTimer ( unsigned int  id)

Gets the time with id.

BaosTimers::Timers BaosTimers::getTimers ( )

Gets the timers from the baos device Does not locally cache them.

void BaosTimers::setTimer ( const Timer timer)

Sets a single timer.

void BaosTimers::setTimers ( const Timers timers)

Sets multiple timers.


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