Public Member Functions | Protected Types | Static Protected Member Functions | List of all members
transmission_interface::TransmissionLoader Class Referenceabstract

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

#include <transmission_loader.h>

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

Public Member Functions

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

Protected Types

enum  ParseStatus { SUCCESS, NO_DATA, BAD_TYPE }
 

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 ParseStatus getActuatorReduction (const TiXmlElement &parent_el, const std::string &actuator_name, const std::string &transmission_name, bool required, double &reduction)
 
static ParseStatus getActuatorRole (const TiXmlElement &parent_el, const std::string &actuator_name, const std::string &transmission_name, bool required, std::string &role)
 
static ParseStatus getJointOffset (const TiXmlElement &parent_el, const std::string &joint_name, const std::string &transmission_name, bool required, double &offset)
 
static ParseStatus getJointReduction (const TiXmlElement &parent_el, const std::string &joint_name, const std::string &transmission_name, bool required, double &reduction)
 
static ParseStatus 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.

Member Enumeration Documentation

◆ ParseStatus

Enumerator
SUCCESS 
NO_DATA 
BAD_TYPE 

Definition at line 69 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 76 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 89 of file transmission_loader.h.

◆ getActuatorReduction()

TransmissionLoader::ParseStatus 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()

TransmissionLoader::ParseStatus 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 141 of file transmission_loader.cpp.

◆ getJointOffset()

TransmissionLoader::ParseStatus 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 106 of file transmission_loader.cpp.

◆ getJointReduction()

TransmissionLoader::ParseStatus 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 71 of file transmission_loader.cpp.

◆ getJointRole()

TransmissionLoader::ParseStatus 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 185 of file transmission_loader.cpp.

◆ load()

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

◆ loadXmlElement()

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

Definition at line 102 of file transmission_loader.h.


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


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