Public Member Functions | Private Attributes | List of all members
hardware_interface::JointModeHandle Class Reference

A handle used to read and mode a single joint. More...

#include <joint_mode_interface.h>

Public Member Functions

JointCommandModes getMode () const
 
std::string getModeName (JointCommandModes mode) const
 
const JointCommandModesgetModePtr () const
 
std::string getName () const
 
 JointModeHandle ()=default
 
 JointModeHandle (std::string name, JointCommandModes *mode)
 
void setMode (JointCommandModes mode)
 

Private Attributes

JointCommandModesmode_ = {nullptr}
 
std::string name_
 

Detailed Description

A handle used to read and mode a single joint.

Definition at line 62 of file joint_mode_interface.h.

Constructor & Destructor Documentation

◆ JointModeHandle() [1/2]

hardware_interface::JointModeHandle::JointModeHandle ( )
default

◆ JointModeHandle() [2/2]

hardware_interface::JointModeHandle::JointModeHandle ( std::string  name,
JointCommandModes mode 
)
inline
Parameters
modeWhich mode to start in

Definition at line 68 of file joint_mode_interface.h.

Member Function Documentation

◆ getMode()

JointCommandModes hardware_interface::JointModeHandle::getMode ( ) const
inline

Definition at line 81 of file joint_mode_interface.h.

◆ getModeName()

std::string hardware_interface::JointModeHandle::getModeName ( JointCommandModes  mode) const
inline

Definition at line 85 of file joint_mode_interface.h.

◆ getModePtr()

const JointCommandModes* hardware_interface::JointModeHandle::getModePtr ( ) const
inline

Definition at line 82 of file joint_mode_interface.h.

◆ getName()

std::string hardware_interface::JointModeHandle::getName ( ) const
inline

Definition at line 78 of file joint_mode_interface.h.

◆ setMode()

void hardware_interface::JointModeHandle::setMode ( JointCommandModes  mode)
inline

Definition at line 80 of file joint_mode_interface.h.

Member Data Documentation

◆ mode_

JointCommandModes* hardware_interface::JointModeHandle::mode_ = {nullptr}
private

Definition at line 110 of file joint_mode_interface.h.

◆ name_

std::string hardware_interface::JointModeHandle::name_
private

Definition at line 111 of file joint_mode_interface.h.


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


hardware_interface
Author(s): Wim Meeussen, Adolfo Rodriguez Tsouroukdissian
autogenerated on Mon Dec 7 2020 03:15:43