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 ()
 

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 64 of file transmission_loader.h.

Member Enumeration Documentation

Enumerator
SUCCESS 
NO_DATA 
BAD_TYPE 

Definition at line 73 of file transmission_loader.h.

Constructor & Destructor Documentation

virtual transmission_interface::TransmissionLoader::~TransmissionLoader ( )
inlinevirtual

Definition at line 68 of file transmission_loader.h.

Member Function Documentation

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

Definition at line 80 of file transmission_loader.h.

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

Definition at line 93 of file transmission_loader.h.

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 39 of file transmission_loader.cpp.

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 144 of file transmission_loader.cpp.

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 109 of file transmission_loader.cpp.

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 74 of file transmission_loader.cpp.

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 188 of file transmission_loader.cpp.

virtual TransmissionSharedPtr transmission_interface::TransmissionLoader::load ( const TransmissionInfo transmission_info)
pure virtual
static TiXmlElement transmission_interface::TransmissionLoader::loadXmlElement ( const std::string &  element_str)
inlinestaticprotected

Definition at line 106 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 Mon Apr 20 2020 03:52:15