Public Member Functions | Protected Member Functions | Protected Attributes | Static Private Member Functions | List of all members
transmission_interface::TransmissionHandle Class Reference

Handle for propagating a single map (position, velocity, or effort) on a single transmission (eg. actuator to joint effort for a simple reducer). More...

#include <transmission_interface.h>

Inheritance diagram for transmission_interface::TransmissionHandle:
Inheritance graph
[legend]

Public Member Functions

std::string getName () const
 

Protected Member Functions

 TransmissionHandle (const std::string &name, Transmission *transmission, const ActuatorData &actuator_data, const JointData &joint_data)
 

Protected Attributes

ActuatorData actuator_data_
 
JointData joint_data_
 
std::string name_
 
Transmissiontransmission_
 

Static Private Member Functions

static bool hasValidPointers (const std::vector< double *> &data)
 

Detailed Description

Handle for propagating a single map (position, velocity, or effort) on a single transmission (eg. actuator to joint effort for a simple reducer).

Definition at line 48 of file transmission_interface.h.

Constructor & Destructor Documentation

◆ TransmissionHandle()

transmission_interface::TransmissionHandle::TransmissionHandle ( const std::string &  name,
Transmission transmission,
const ActuatorData actuator_data,
const JointData joint_data 
)
inlineprotected
Parameters
nameTransmission name.
transmissionPointer to transmission instance.
actuator_dataActuator-space variables.
joint_dataJoint-space variables.
Note
The lifecycle of the pointed-to instances passed as parameters is not handled by this class.
Precondition
Valid transmission pointer. Actuator and joint variable vectors required by this handle must contain valid data and their size should be consistent with the number of transmission actuators and joints. Data vectors not used by this handle can remain empty.

Definition at line 70 of file transmission_interface.h.

Member Function Documentation

◆ getName()

std::string transmission_interface::TransmissionHandle::getName ( ) const
inline
Returns
Transmission name.

Definition at line 52 of file transmission_interface.h.

◆ hasValidPointers()

static bool transmission_interface::TransmissionHandle::hasValidPointers ( const std::vector< double *> &  data)
inlinestaticprivate

Definition at line 181 of file transmission_interface.h.

Member Data Documentation

◆ actuator_data_

ActuatorData transmission_interface::TransmissionHandle::actuator_data_
protected

Definition at line 57 of file transmission_interface.h.

◆ joint_data_

JointData transmission_interface::TransmissionHandle::joint_data_
protected

Definition at line 58 of file transmission_interface.h.

◆ name_

std::string transmission_interface::TransmissionHandle::name_
protected

Definition at line 55 of file transmission_interface.h.

◆ transmission_

Transmission* transmission_interface::TransmissionHandle::transmission_
protected

Definition at line 56 of file transmission_interface.h.


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


transmission_interface
Author(s): Adolfo Rodriguez Tsouroukdissian
autogenerated on Sun May 10 2020 03:14:56