ros2_control - jazzy
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
transmission_interface::DifferentialTransmission Class Reference
Inheritance diagram for transmission_interface::DifferentialTransmission:
Inheritance graph
[legend]
Collaboration diagram for transmission_interface::DifferentialTransmission:
Collaboration graph
[legend]

Public Member Functions

 DifferentialTransmission (const std::vector< double > &actuator_reduction, const std::vector< double > &joint_reduction, const std::vector< double > &joint_offset={0.0, 0.0})
 
void configure (const std::vector< JointHandle > &joint_handles, const std::vector< ActuatorHandle > &actuator_handles) override
 
void actuator_to_joint () override
 Transform variables from actuator to joint space.
 
void joint_to_actuator () override
 Transform variables from joint to actuator space.
 
std::size_t num_actuators () const override
 
std::size_t num_joints () const override
 
const std::vector< double > & get_actuator_reduction () const
 
const std::vector< double > & get_joint_reduction () const
 
const std::vector< double > & get_joint_offset () const
 
std::string get_handles_info () const
 Get human-friendly report of handles.
 

Protected Attributes

std::vector< double > actuator_reduction_
 
std::vector< double > joint_reduction_
 
std::vector< double > joint_offset_
 
std::vector< JointHandlejoint_position_
 
std::vector< JointHandlejoint_velocity_
 
std::vector< JointHandlejoint_effort_
 
std::vector< JointHandlejoint_torque_
 
std::vector< JointHandlejoint_absolute_position_
 
std::vector< ActuatorHandleactuator_position_
 
std::vector< ActuatorHandleactuator_velocity_
 
std::vector< ActuatorHandleactuator_effort_
 
std::vector< ActuatorHandleactuator_torque_
 
std::vector< ActuatorHandleactuator_absolute_position_
 

Constructor & Destructor Documentation

◆ DifferentialTransmission()

transmission_interface::DifferentialTransmission::DifferentialTransmission ( const std::vector< double > &  actuator_reduction,
const std::vector< double > &  joint_reduction,
const std::vector< double > &  joint_offset = {0.0, 0.0} 
)
inline
Parameters
[in]actuator_reductionReduction ratio of actuators.
[in]joint_reductionReduction ratio of joints.
[in]joint_offsetJoint position offset used in the position mappings.
Precondition
Nonzero actuator and joint reduction values.

Member Function Documentation

◆ actuator_to_joint()

void transmission_interface::DifferentialTransmission::actuator_to_joint ( )
inlineoverridevirtual

Transform variables from actuator to joint space.

Precondition
Actuator and joint vectors must have size 2 and point to valid data. To call this method it is not required that all other data vectors contain valid data, and can even remain empty.

Implements transmission_interface::Transmission.

◆ configure()

void transmission_interface::DifferentialTransmission::configure ( const std::vector< JointHandle > &  joint_handles,
const std::vector< ActuatorHandle > &  actuator_handles 
)
overridevirtual
Parameters
[in]joint_handlesHandles of joint values.
[in]actuator_handlesHandles of actuator values.
Precondition
Handles are valid and matching in size

Implements transmission_interface::Transmission.

◆ joint_to_actuator()

void transmission_interface::DifferentialTransmission::joint_to_actuator ( )
inlineoverridevirtual

Transform variables from joint to actuator space.

Precondition
Actuator and joint vectors must have size 2 and point to valid data. To call this method it is not required that all other data vectors contain valid data, and can even remain empty.

Implements transmission_interface::Transmission.

◆ num_actuators()

std::size_t transmission_interface::DifferentialTransmission::num_actuators ( ) const
inlineoverridevirtual
Returns
Number of actuators managed by transmission, ie. the dimension of the actuator space.

Implements transmission_interface::Transmission.

◆ num_joints()

std::size_t transmission_interface::DifferentialTransmission::num_joints ( ) const
inlineoverridevirtual
Returns
Number of joints managed by transmission, ie. the dimension of the joint space.

Implements transmission_interface::Transmission.


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