Robotics Library  0.7.0
CyclicDevice.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2009, Markus Rickert
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 //
8 // * Redistributions of source code must retain the above copyright notice,
9 // this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright notice,
11 // this list of conditions and the following disclaimer in the documentation
12 // and/or other materials provided with the distribution.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 // POSSIBILITY OF SUCH DAMAGE.
25 //
26 
27 #ifndef RL_HAL_CYCLICDEVICE_H
28 #define RL_HAL_CYCLICDEVICE_H
29 
30 #include <chrono>
31 
32 #include "Device.h"
33 
34 namespace rl
35 {
36  namespace hal
37  {
38  class CyclicDevice : public virtual Device
39  {
40  public:
41  CyclicDevice(const ::std::chrono::nanoseconds& updateRate);
42 
43  virtual ~CyclicDevice();
44 
45  virtual ::std::chrono::nanoseconds getUpdateRate() const;
46 
50  virtual void step() = 0;
51 
52  protected:
53 
54  private:
55  ::std::chrono::nanoseconds updateRate;
56  };
57  }
58 }
59 
60 #endif // RL_HAL_CYCLICDEVICE_H
rl::hal::CyclicDevice::step
virtual void step()=0
rl::hal::Device
Definition: Device.h:41
rl::hal::CyclicDevice::~CyclicDevice
virtual ~CyclicDevice()
Definition: CyclicDevice.cpp:39
rl::hal::CyclicDevice
Definition: CyclicDevice.h:39
rl::hal::CyclicDevice::CyclicDevice
CyclicDevice(const ::std::chrono::nanoseconds &updateRate)
Definition: CyclicDevice.cpp:33
Device.h
rl::hal::CyclicDevice::getUpdateRate
virtual ::std::chrono::nanoseconds getUpdateRate() const
Definition: CyclicDevice.cpp:44
rl::hal::CyclicDevice::updateRate
::std::chrono::nanoseconds updateRate
Definition: CyclicDevice.h:55
rl
Robotics Library.
Definition: AnalogInput.cpp:30