robotiq_s_model_control::SModelEtherCatClient Class Reference

This class provides a client for the EtherCAT manager object that can translate robot input/output messages and translate them to the underlying IO Map. More...

#include <s_model_ethercat_client.h>

List of all members.

Public Types
typedef robotiq_s_model_control::SModel_robot_input	GripperInput
typedef robotiq_s_model_control::SModel_robot_output	GripperOutput
Public Member Functions
GripperInput	readInputs () const
	Reads set of input-register values from the gripper.
GripperOutput	readOutputs () const
	Reads set of output-register values from the gripper.
	SModelEtherCatClient (robotiq_ethercat::EtherCatManager &manager, int slave_no)
	Constructs a control interface to a S Model Robotiq gripper on the given ethercat network and the given slave_no.
void	writeOutputs (const GripperOutput &output)
	Write the given set of control flags to the memory of the gripper.
Private Attributes
robotiq_ethercat::EtherCatManager &	manager_
const int	slave_no_

---

Detailed Description

This class provides a client for the EtherCAT manager object that can translate robot input/output messages and translate them to the underlying IO Map.

Definition at line 22 of file s_model_ethercat_client.h.

---

Member Typedef Documentation

typedef robotiq_s_model_control::SModel_robot_input robotiq_s_model_control::SModelEtherCatClient::GripperInput

Definition at line 26 of file s_model_ethercat_client.h.

typedef robotiq_s_model_control::SModel_robot_output robotiq_s_model_control::SModelEtherCatClient::GripperOutput

Definition at line 25 of file s_model_ethercat_client.h.

---

Constructor & Destructor Documentation

robotiq_s_model_control::SModelEtherCatClient::SModelEtherCatClient	(	robotiq_ethercat::EtherCatManager &	manager,
		int	slave_no
	)

Constructs a control interface to a S Model Robotiq gripper on the given ethercat network and the given slave_no.

Parameters:

[in]	manager	The interface to an EtherCAT network that the gripper is connected to.
[in]	slave_no	The slave number of the gripper on the EtherCAT network (>= 1)

Definition at line 10 of file s_model_ethercat_client.cpp.

---

Member Function Documentation

SModelEtherCatClient::GripperInput robotiq_s_model_control::SModelEtherCatClient::readInputs

(

)

const

Reads set of input-register values from the gripper.

Returns:

The gripper input registers as read from the controller IOMap

Definition at line 57 of file s_model_ethercat_client.cpp.

SModelEtherCatClient::GripperOutput robotiq_s_model_control::SModelEtherCatClient::readOutputs

(

)

const

Reads set of output-register values from the gripper.

Returns:

The gripper output registers as read from the controller IOMap

Definition at line 108 of file s_model_ethercat_client.cpp.

void robotiq_s_model_control::SModelEtherCatClient::writeOutputs

(

const GripperOutput &

output

)

Write the given set of control flags to the memory of the gripper.

Parameters:

[in]

output

The set of output-register values to write to the gripper

Definition at line 19 of file s_model_ethercat_client.cpp.

---

Member Data Documentation

robotiq_ethercat::EtherCatManager& robotiq_s_model_control::SModelEtherCatClient::manager_ [private]

Definition at line 60 of file s_model_ethercat_client.h.

const int robotiq_s_model_control::SModelEtherCatClient::slave_no_ [private]

Definition at line 61 of file s_model_ethercat_client.h.

---

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

• s_model_ethercat_client.h
• s_model_ethercat_client.cpp