Public Member Functions | Private Attributes | List of all members
franka_hw::FrankaStateHandle Class Reference

Handle to read the complete state of a robot. More...

#include <franka_state_interface.h>

Inheritance diagram for franka_hw::FrankaStateHandle:
Inheritance graph

Public Member Functions

 FrankaStateHandle ()=delete
 FrankaStateHandle (const std::string &name, franka::RobotState &robot_state)
 Creates an instance of a FrankaStateHandle. More...
const std::string & getName () const noexcept
 Gets the name of the state handle. More...
const franka::RobotStategetRobotState () const noexcept
 Gets the current robot state. More...

Private Attributes

std::string name_
const franka::RobotStaterobot_state_

Detailed Description

Handle to read the complete state of a robot.

Definition at line 15 of file franka_state_interface.h.

Constructor & Destructor Documentation

franka_hw::FrankaStateHandle::FrankaStateHandle ( )
franka_hw::FrankaStateHandle::FrankaStateHandle ( const std::string &  name,
franka::RobotState robot_state 

Creates an instance of a FrankaStateHandle.

[in]nameThe name of the state handle.
[in]robot_stateA reference to the robot state wrapped by this handle.

Definition at line 25 of file franka_state_interface.h.

Member Function Documentation

const std::string& franka_hw::FrankaStateHandle::getName ( ) const

Gets the name of the state handle.

Name of the state handle.

Definition at line 33 of file franka_state_interface.h.

const franka::RobotState& franka_hw::FrankaStateHandle::getRobotState ( ) const

Gets the current robot state.

Current robot state.

Definition at line 40 of file franka_state_interface.h.

Member Data Documentation

std::string franka_hw::FrankaStateHandle::name_

Definition at line 43 of file franka_state_interface.h.

const franka::RobotState* franka_hw::FrankaStateHandle::robot_state_

Definition at line 44 of file franka_state_interface.h.

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

Author(s): Franka Emika GmbH
autogenerated on Fri Oct 23 2020 03:47:05