actuator_command_interface.h
Go to the documentation of this file.
1 // Copyright (C) 2012, hiDOF INC.
3 // Copyright (C) 2013, PAL Robotics S.L.
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 // * Redistributions of source code must retain the above copyright notice,
8 // this list of conditions and the following disclaimer.
9 // * Redistributions in binary form must reproduce the above copyright
10 // notice, this list of conditions and the following disclaimer in the
11 // documentation and/or other materials provided with the distribution.
12 // * Neither the name of hiDOF, Inc. nor the names of its
13 // contributors may be used to endorse or promote products derived from
14 // this software without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 // POSSIBILITY OF SUCH DAMAGE.
28 
29 #pragma once
30 
31 
32 #include <string>
35 
37 {
38 
41 {
42 public:
43  ActuatorHandle() = default;
44 
49  ActuatorHandle(const ActuatorStateHandle& as, double* cmd)
50  : ActuatorStateHandle(as), cmd_(cmd)
51  {
52  if (!cmd_)
53  {
54  throw HardwareInterfaceException("Cannot create handle '" + as.getName() + "'. Command data pointer is null.");
55  }
56  }
57 
58  void setCommand(double command) {assert(cmd_); *cmd_ = command;}
59  double getCommand() const {assert(cmd_); return *cmd_;}
60 
61  double* getCommandPtr() {return cmd_;}
62 
63 private:
64  double* cmd_ = {nullptr};
65 };
66 
76 class ActuatorCommandInterface : public HardwareResourceManager<ActuatorHandle> {};
77 
80 
83 
86 
87 }
command
ROSLIB_DECL std::string command(const std::string &cmd)
hardware_interface::ActuatorStateHandle
A handle used to read the state of a single actuator. Currently, position, velocity and effort fields...
Definition: actuator_state_interface.h:45
hardware_interface::ActuatorHandle::setCommand
void setCommand(double command)
Definition: actuator_command_interface.h:58
hardware_interface::ActuatorHandle::cmd_
double * cmd_
Definition: actuator_command_interface.h:64
hardware_interface::ActuatorHandle::ActuatorHandle
ActuatorHandle(const ActuatorStateHandle &as, double *cmd)
Definition: actuator_command_interface.h:49
hardware_interface::PositionActuatorInterface
ActuatorCommandInterface for commanding position-based actuators
Definition: actuator_command_interface.h:85
hardware_interface::VelocityActuatorInterface
ActuatorCommandInterface for commanding velocity-based actuators
Definition: actuator_command_interface.h:82
hardware_interface::ActuatorCommandInterface
Hardware interface to support commanding an array of actuators.
Definition: actuator_command_interface.h:76
hardware_interface
Definition: actuator_command_interface.h:36
hardware_interface::ActuatorHandle::getCommandPtr
double * getCommandPtr()
Definition: actuator_command_interface.h:61
hardware_interface::ActuatorHandle::ActuatorHandle
ActuatorHandle()=default
actuator_state_interface.h
hardware_interface::ActuatorHandle
A handle used to read and command a single actuator.
Definition: actuator_command_interface.h:40
hardware_interface::ActuatorHandle::getCommand
double getCommand() const
Definition: actuator_command_interface.h:59
hardware_interface::HardwareInterfaceException
An exception related to a HardwareInterface.
Definition: hardware_interface.h:71
hardware_interface::EffortActuatorInterface
ActuatorCommandInterface for commanding effort-based actuators
Definition: actuator_command_interface.h:79
hardware_interface::ActuatorStateHandle::getName
std::string getName() const
Definition: actuator_state_interface.h:167
hardware_interface::HardwareResourceManager
Base class for handling hardware resources.
Definition: hardware_resource_manager.h:79
hardware_resource_manager.h


hardware_interface
Author(s): Wim Meeussen, Adolfo Rodriguez Tsouroukdissian
autogenerated on Sat Mar 27 2021 02:07:25