argos::CCI_GripperActuator Class Reference

#include <ci_gripper_actuator.h>

Inheritance diagram for argos::CCI_GripperActuator:
Collaboration diagram for argos::CCI_GripperActuator:

Public Member Functions

 CCI_GripperActuator ()
 Class constructor. More...
 
virtual ~CCI_GripperActuator ()
 Class destructor. More...
 
void SetLockState (Real f_lock_state)
 Sets the gripper lock state. More...
 
void Lock ()
 Locks the gripper. More...
 
void Unlock ()
 Unlocks the gripper. More...
 
- Public Member Functions inherited from argos::CCI_Actuator
virtual ~CCI_Actuator ()
 Class destructor. More...
 
virtual void Init (TConfigurationNode &t_node)
 Initializes the actuator from the XML configuration tree. More...
 
virtual void Reset ()
 Resets the actuator to the state it had just after Init(). More...
 
virtual void Destroy ()
 Destroys the actuator. More...
 
- Public Member Functions inherited from argos::CBaseConfigurableResource
virtual ~CBaseConfigurableResource ()
 Class destructor. More...
 

Protected Attributes

Real m_fLockState
 

Additional Inherited Members

- Public Types inherited from argos::CCI_Actuator
typedef std::map< std::string, CCI_Actuator *, std::less< std::string > > TMap
 

Detailed Description

Definition at line 18 of file ci_gripper_actuator.h.

Constructor & Destructor Documentation

argos::CCI_GripperActuator::CCI_GripperActuator ( )

Class constructor.

Definition at line 55 of file ci_gripper_actuator.cpp.

virtual argos::CCI_GripperActuator::~CCI_GripperActuator ( )
inlinevirtual

Class destructor.

Definition at line 30 of file ci_gripper_actuator.h.

Member Function Documentation

void argos::CCI_GripperActuator::Lock ( )

Locks the gripper.

This corresponds to calling SetLockState(1.0f).

See also
SetLockState()

Definition at line 69 of file ci_gripper_actuator.cpp.

void argos::CCI_GripperActuator::SetLockState ( Real  f_lock_state)

Sets the gripper lock state.

The lock state is a value between 0 and 1, where 0 means unlocked, and 1 means locked.

Parameters
f_lock_stateThe desired lock state.

Definition at line 61 of file ci_gripper_actuator.cpp.

void argos::CCI_GripperActuator::Unlock ( )

Unlocks the gripper.

This corresponds to calling SetLockState(0.0f).

See also
SetLockState()

Definition at line 76 of file ci_gripper_actuator.cpp.

Member Data Documentation

Real argos::CCI_GripperActuator::m_fLockState
protected

Definition at line 60 of file ci_gripper_actuator.h.