transmission_interface::TransmissionLoader Class Reference

Abstract interface for loading transmission instances from configuration data. More...

#include <transmission_loader.h>

Inheritance diagram for transmission_interface::TransmissionLoader:

Public Member Functions
virtual TransmissionSharedPtr	load (const TransmissionInfo &transmission_info)=0
virtual	~TransmissionLoader ()=default

Static Protected Member Functions
static bool	checkActuatorDimension (const TransmissionInfo &transmission_info, const unsigned int expected_dim)
static bool	checkJointDimension (const TransmissionInfo &transmission_info, const unsigned int expected_dim)
static bool	getActuatorReduction (const TiXmlElement &parent_el, const std::string &actuator_name, const std::string &transmission_name, bool required, double &reduction)
static bool	getActuatorRole (const TiXmlElement &parent_el, const std::string &actuator_name, const std::string &transmission_name, bool required, std::string &role)
static bool	getJointOffset (const TiXmlElement &parent_el, const std::string &joint_name, const std::string &transmission_name, bool required, double &offset)
static bool	getJointReduction (const TiXmlElement &parent_el, const std::string &joint_name, const std::string &transmission_name, bool required, double &reduction)
static bool	getJointRole (const TiXmlElement &parent_el, const std::string &joint_name, const std::string &transmission_name, bool required, std::string &role)
static TiXmlElement	loadXmlElement (const std::string &element_str)

Detailed Description

Abstract interface for loading transmission instances from configuration data.

It also provides convenience methods for specific transmission loaders to leverage.

Definition at line 61 of file transmission_loader.h.

Constructor & Destructor Documentation

~TransmissionLoader()

virtual transmission_interface::TransmissionLoader::~TransmissionLoader ( )

virtualdefault

Member Function Documentation

checkActuatorDimension()

static bool transmission_interface::TransmissionLoader::checkActuatorDimension ( const TransmissionInfo &  transmission_info, const unsigned int  expected_dim  )

inlinestaticprotected

Definition at line 70 of file transmission_loader.h.

checkJointDimension()

static bool transmission_interface::TransmissionLoader::checkJointDimension ( const TransmissionInfo &  transmission_info, const unsigned int  expected_dim  )

inlinestaticprotected

Definition at line 83 of file transmission_loader.h.

getActuatorReduction()

bool transmission_interface::TransmissionLoader::getActuatorReduction ( const TiXmlElement &  parent_el, const std::string &  actuator_name, const std::string &  transmission_name, bool  required, double &  reduction  )

staticprotected

Definition at line 36 of file transmission_loader.cpp.

getActuatorRole()

bool transmission_interface::TransmissionLoader::getActuatorRole ( const TiXmlElement &  parent_el, const std::string &  actuator_name, const std::string &  transmission_name, bool  required, std::string &  role  )

staticprotected

Definition at line 144 of file transmission_loader.cpp.

getJointOffset()

bool transmission_interface::TransmissionLoader::getJointOffset ( const TiXmlElement &  parent_el, const std::string &  joint_name, const std::string &  transmission_name, bool  required, double &  offset  )

staticprotected

Definition at line 108 of file transmission_loader.cpp.

getJointReduction()

bool transmission_interface::TransmissionLoader::getJointReduction ( const TiXmlElement &  parent_el, const std::string &  joint_name, const std::string &  transmission_name, bool  required, double &  reduction  )

staticprotected

Definition at line 72 of file transmission_loader.cpp.

getJointRole()

bool transmission_interface::TransmissionLoader::getJointRole ( const TiXmlElement &  parent_el, const std::string &  joint_name, const std::string &  transmission_name, bool  required, std::string &  role  )

staticprotected

Definition at line 190 of file transmission_loader.cpp.

load()

virtual TransmissionSharedPtr transmission_interface::TransmissionLoader::load ( const TransmissionInfo &  transmission_info )

pure virtual

Implemented in transmission_interface::DifferentialTransmissionLoader, transmission_interface::FourBarLinkageTransmissionLoader, and transmission_interface::SimpleTransmissionLoader.

loadXmlElement()

static TiXmlElement transmission_interface::TransmissionLoader::loadXmlElement ( const std::string &  element_str )

inlinestaticprotected

Definition at line 96 of file transmission_loader.h.

---

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

• transmission_loader.h
• transmission_loader.cpp