Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
motoman::io_ctrl::MotomanIoCtrl Class Reference

Wrapper class around Motoman-specific io control commands. More...

#include <io_ctrl.h>

Public Member Functions

bool init (SmplMsgConnection *connection)
 
 MotomanIoCtrl ()
 Default constructor. More...
 
bool readSingleIO (industrial::shared_types::shared_int address, industrial::shared_types::shared_int &value, std::string &err_msg)
 Reads a single IO point on the controller. More...
 
bool writeSingleIO (industrial::shared_types::shared_int address, industrial::shared_types::shared_int value, std::string &err_msg)
 Writes to a single IO point on the controller. More...
 

Protected Member Functions

bool sendAndReceive (industrial::shared_types::shared_int address, ReadSingleIOReply &reply)
 
bool sendAndReceive (industrial::shared_types::shared_int address, industrial::shared_types::shared_int value, WriteSingleIOReply &reply)
 

Protected Attributes

SmplMsgConnectionconnection_
 

Detailed Description

Wrapper class around Motoman-specific io control commands.

Definition at line 56 of file io_ctrl.h.

Constructor & Destructor Documentation

motoman::io_ctrl::MotomanIoCtrl::MotomanIoCtrl ( )
inline

Default constructor.

Definition at line 62 of file io_ctrl.h.

Member Function Documentation

bool motoman::io_ctrl::MotomanIoCtrl::init ( SmplMsgConnection connection)

Definition at line 62 of file io_ctrl.cpp.

bool motoman::io_ctrl::MotomanIoCtrl::readSingleIO ( industrial::shared_types::shared_int  address,
industrial::shared_types::shared_int value,
std::string &  err_msg 
)

Reads a single IO point on the controller.

Note: if reading was unsuccessful, the value of value is undefined.

Parameters
addressThe address (index) of the IO point
value[out] Will contain the value of the IO point
err_msg[out] A descriptive error message in case of failure
Returns
True IFF reading was successful

Definition at line 68 of file io_ctrl.cpp.

bool motoman::io_ctrl::MotomanIoCtrl::sendAndReceive ( industrial::shared_types::shared_int  address,
ReadSingleIOReply reply 
)
protected

Definition at line 108 of file io_ctrl.cpp.

bool motoman::io_ctrl::MotomanIoCtrl::sendAndReceive ( industrial::shared_types::shared_int  address,
industrial::shared_types::shared_int  value,
WriteSingleIOReply reply 
)
protected

Definition at line 131 of file io_ctrl.cpp.

bool motoman::io_ctrl::MotomanIoCtrl::writeSingleIO ( industrial::shared_types::shared_int  address,
industrial::shared_types::shared_int  value,
std::string &  err_msg 
)

Writes to a single IO point on the controller.

Parameters
addressThe address (index) of the IO point
valueThe value to set the IO element to
err_msg[out] A descriptive error message in case of failure
Returns
True IFF writing was successful

Definition at line 89 of file io_ctrl.cpp.

Member Data Documentation

SmplMsgConnection* motoman::io_ctrl::MotomanIoCtrl::connection_
protected

Definition at line 92 of file io_ctrl.h.


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


motoman_driver
Author(s): Jeremy Zoss (Southwest Research Institute), Ted Miller (MotoROS) (Yaskawa Motoman), Eric Marcil (MotoROS) (Yaskawa Motoman)
autogenerated on Sat May 8 2021 02:27:44