TwiceAsNice  2019-02-18
Public Member Functions | List of all members
Basda::MPIACoreModule Class Reference

This is the base class of the MPIA in-house electronic modules with the core commands. More...

#include <Module.h>

Inheritance diagram for Basda::MPIACoreModule:
Inheritance graph
Collaboration diagram for Basda::MPIACoreModule:
Collaboration graph

Public Member Functions

 MPIACoreModule (std::string _name, Nice::JointPtr _config, Basda::MPIACoreProtocolPtr _protocol)
 Constructor. More...
 
 ~MPIACoreModule ()
 Destructor. More...
 
void open ()
 
void close ()
 
bool configParameterUploadRequired ()
 
 MPIACoreModule (std::string _name, Nice::JointPtr _config, Basda::MPIACoreProtocolPtr _protocol)
 Constructor. More...
 
 ~MPIACoreModule ()
 Destructor. More...
 
void open ()
 
void close ()
 
bool configParameterUploadRequired ()
 

Additional Inherited Members

- Protected Member Functions inherited from Basda::MPIACore
 MPIACore (std::string _name, Nice::JointPtr _config, const MPIACoreProtocolPtr _protocol)
 
 ~MPIACore ()
 
template<typename Type >
Type checkAttribute (const std::string &_node, const std::string &_attributeName, const Type &_default)
 
template<typename RT >
std::vector< RT > getVector (const std::string &_str)
 This is a generic method to convert a data string to a vector. More...
 
std::string name ()
 
 MPIACore (std::string _name, Nice::JointPtr _config, const MPIACoreProtocolPtr _protocol)
 
 ~MPIACore ()
 
template<typename Type >
Type checkAttribute (const std::string &_node, const std::string &_attributeName, const Type &_default)
 
template<typename RT >
std::vector< RT > getVector (const std::string &_str)
 This is a generic method to convert a data string to a vector. More...
 
std::string name ()
 
- Static Protected Member Functions inherited from Basda::MPIACore
template<typename RT >
static RT getValue (const std::string &_str)
 This is a generic method to convert a data string to a number. More...
 
template<typename RT >
static RT getValue (const std::string &_str)
 This is a generic method to convert a data string to a number. More...
 
- Protected Attributes inherited from Basda::MPIACore
std::string m_name
 
std::string m_address
 member of the connection address More...
 
unsigned int m_cardNo
 member of the card number More...
 
unsigned int m_moduleNo
 member of the module number More...
 
HandlerPtr m_handler
 
MPIACoreProtocolPtr m_protocol
 member of the protocol to communicate with the MPIA in-house electronic. More...
 
Nice::JointPtr m_config
 member of the root of the configuration tree More...
 
bool m_warning
 

Detailed Description

This is the base class of the MPIA in-house electronic modules with the core commands.

A MPIA in-house electronic card is the backplate for the on-board modules. A module is the smallest unit of the MPIA in-house electronic. The module can be either an active element like a motor or a passive element like a temperature sensor. This class represents the generic MPIA in-house electronic module with the functionalities that are supported by all MPIA in-house electronic modules. It has to extend with the specific MPIA in-house electronic module functionalities.

This class reserve the module at the MPIA in-house electronic and ensure a serial command flow.

Author
Frank Kittmann
Version
09.06.23
Date
2009.06.23
See also
Basda::MPIACore
Basda::MoConModule

Constructor & Destructor Documentation

◆ MPIACoreModule() [1/2]

Basda::MPIACoreModule::MPIACoreModule ( std::string  _name,
Nice::JointPtr  _config,
Basda::MPIACoreProtocolPtr  _protocol 
)

Constructor.

This constructor register itself at the protocol and reserve the MPIA in-house electronic module.

Parameters
_configthe root of the configuration tree
_eventHandlePtrthe smart pointer to the event handler object

◆ ~MPIACoreModule() [1/2]

Basda::MPIACoreModule::~MPIACoreModule ( )

Destructor.

◆ MPIACoreModule() [2/2]

Basda::MPIACoreModule::MPIACoreModule ( std::string  _name,
Nice::JointPtr  _config,
Basda::MPIACoreProtocolPtr  _protocol 
)

Constructor.

This constructor register itself at the protocol and reserve the MPIA in-house electronic module.

Parameters
_configthe root of the configuration tree
_eventHandlePtrthe smart pointer to the event handler object

◆ ~MPIACoreModule() [2/2]

Basda::MPIACoreModule::~MPIACoreModule ( )

Destructor.

Member Function Documentation

◆ close() [1/2]

void Basda::MPIACoreModule::close ( )

◆ close() [2/2]

void Basda::MPIACoreModule::close ( )

◆ configParameterUploadRequired() [1/2]

bool Basda::MPIACoreModule::configParameterUploadRequired ( )

◆ configParameterUploadRequired() [2/2]

bool Basda::MPIACoreModule::configParameterUploadRequired ( )

◆ open() [1/2]

void Basda::MPIACoreModule::open ( )

◆ open() [2/2]

void Basda::MPIACoreModule::open ( )

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