Static Public Member Functions | Private Member Functions | Static Private Attributes | Friends | List of all members
youbot::EthercatMaster Class Reference

The Ethercat Master factory. More...

#include <EthercatMaster.hpp>

Static Public Member Functions

static void destroy ()
 destroy the singleton instance by calling the destructor More...
static EthercatMasterInterfacegetInstance (const std::string configFile="youbot-ethercat.cfg", const std::string configFilePath="../config/", const bool ethercatMasterWithThread=true)

Private Member Functions

 EthercatMaster ()
 EthercatMaster (const EthercatMaster &)
 ~EthercatMaster ()

Static Private Attributes

static EthercatMasterInterfaceinstance = 0


class YouBotGripper
class YouBotGripperBar
class YouBotJoint

Detailed Description

The Ethercat Master factory.

Definition at line 61 of file EthercatMaster.hpp.

Constructor & Destructor Documentation

youbot::EthercatMaster::EthercatMaster ( )

Definition at line 68 of file EthercatMaster.hpp.

youbot::EthercatMaster::EthercatMaster ( const EthercatMaster )

Definition at line 70 of file EthercatMaster.hpp.

youbot::EthercatMaster::~EthercatMaster ( )

Definition at line 72 of file EthercatMaster.hpp.

Member Function Documentation

void youbot::EthercatMaster::destroy ( )

destroy the singleton instance by calling the destructor

Definition at line 77 of file EthercatMaster.cpp.

EthercatMasterInterface & youbot::EthercatMaster::getInstance ( const std::string  configFile = "youbot-ethercat.cfg",
const std::string  configFilePath = "../config/",
const bool  ethercatMasterWithThread = true 

creates a instance of the singleton EthercatMaster if there is none and returns a reference to it

configFileconfiguration file name incl. the extension
configFilePaththe path where the configuration is located with a / at the end
ethercatMasterWithThreadset it to false if you want to deactivate the communication thread

Definition at line 62 of file EthercatMaster.cpp.

Friends And Related Function Documentation

friend class YouBotGripper

Definition at line 63 of file EthercatMaster.hpp.

friend class YouBotGripperBar

Definition at line 64 of file EthercatMaster.hpp.

friend class YouBotJoint

Definition at line 62 of file EthercatMaster.hpp.

Member Data Documentation

EthercatMasterInterface * youbot::EthercatMaster::instance = 0

Definition at line 66 of file EthercatMaster.hpp.

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

Author(s): Jan Paulus
autogenerated on Mon Jun 10 2019 15:46:27