rec::robotino::api2::ElectricalGripper Class Reference

Represents a digital output device. More...

#include <ElectricalGripper.h>

Inheritance diagram for rec::robotino::api2::ElectricalGripper:

Public Types
enum	{ IsMoving, IsOpen, IsClosed }

Public Member Functions
void	setComId (const ComId &id)
void	open ()
void	close ()
bool	isOpened () const
bool	isClosed () const
virtual void	stateChangedEvent (int state)
Public Member Functions inherited from rec::robotino::api2::ComObject
	ComObject ()
virtual	~ComObject ()
ComId	comId () const

Friends
class	ElectricalGripperImpl

Additional Inherited Members
Protected Attributes inherited from rec::robotino::api2::ComObject
ComId	_comID

Detailed Description

Represents a digital output device.

Member Function Documentation

void rec::robotino::api2::ElectricalGripper::close

(

)

Close the electrical gripper.

Exceptions

RobotinoException

if the current communication object is invalid.

bool rec::robotino::api2::ElectricalGripper::isClosed

(

)

const

Returns

Returns true if ElectricalGripper is closed. False otherwise.

Exceptions

nothing

See also

isOpened

bool rec::robotino::api2::ElectricalGripper::isOpened

(

)

const

Returns

Returns true if ElectricalGripper is opened. False otherwise.

Exceptions

nothing

See also

isClosed

void rec::robotino::api2::ElectricalGripper::open

(

)

Open the electrical gripper.

Exceptions

RobotinoException

if the current communication object is invalid.

void rec::robotino::api2::ElectricalGripper::setComId

(

const ComId &

id

)

Sets the associated communication object.

Parameters

id	The id of the associated communication object.

Exceptions

RobotinoException

if given id is invalid.

Remarks

This function is thread save

virtual void rec::robotino::api2::ElectricalGripper::stateChangedEvent ( int  state )

virtual

Called when the grippers state changes

Parameters

state

ElectricalGripper::IsOpen if the gripper is opened. ElectricalGripper::IsClosed if the gripper is closed. ElectricalGripper::IsMoving is the gripper is moving, i.e. between opened and closed.

Remarks

This function is called from the thread in which Com::processEvents() is called.

See also

Com::processEvents

---

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

• C:/srcs/git/openrobotino/api2/lib/rec/robotino/api2/ElectricalGripper.h