gazebo::VacuumGripperPlugin Class Reference

#include <VacuumGripperPlugin.hh>

Inheritance diagram for gazebo::VacuumGripperPlugin:

List of all members.

Public Member Functions
bool	Attached () const
	True if the gripper is attached to another model.
void	Disable ()
	Disable the suction.
void	Enable ()
	Enable the suction.
bool	Enabled () const
	Whether the suction of the gripper has been enabled.
virtual void	Load (physics::ModelPtr _model, sdf::ElementPtr _sdf)
std::string	Name () const
	Return the name of the gripper.
virtual void	Reset ()
	Documentation inherited.
	VacuumGripperPlugin ()
	Constructor.
virtual	~VacuumGripperPlugin ()
	Destructor.
Private Member Functions
void	HandleAttach ()
	Attach an object to the gripper.
void	HandleDetach ()
	Detach an object from the gripper.
void	OnContacts (ConstContactsPtr &_msg)
	Callback used when the gripper contacts an object.
void	OnUpdate ()
	Update the gripper.
virtual void	Publish () const
	Overwrite this method for sending periodic updates with the gripper state.
Private Attributes
std::unique_ptr < VacuumGripperPluginPrivate >	dataPtr

---

Detailed Description

Definition at line 35 of file VacuumGripperPlugin.hh.

---

Constructor & Destructor Documentation

VacuumGripperPlugin::VacuumGripperPlugin

(

)

[explicit]

Constructor.

Definition at line 164 of file VacuumGripperPlugin.cc.

VacuumGripperPlugin::~VacuumGripperPlugin

(

)

[virtual]

Destructor.

Definition at line 174 of file VacuumGripperPlugin.cc.

---

Member Function Documentation

bool VacuumGripperPlugin::Attached

(

)

const

True if the gripper is attached to another model.

Returns:

True if the gripper is active and a joint has been created between the gripper and another model.

Definition at line 346 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::Disable

(

)

Disable the suction.

Definition at line 359 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::Enable

(

)

Enable the suction.

Definition at line 352 of file VacuumGripperPlugin.cc.

bool VacuumGripperPlugin::Enabled

(

)

const

Whether the suction of the gripper has been enabled.

Definition at line 340 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::HandleAttach

(

)

[private]

Attach an object to the gripper.

Definition at line 446 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::HandleDetach

(

)

[private]

Detach an object from the gripper.

Definition at line 520 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::Load	(	physics::ModelPtr	_model,
		sdf::ElementPtr	_sdf
	)		[virtual]

Reimplemented in gazebo::ROSVacuumGripperPlugin.

Definition at line 184 of file VacuumGripperPlugin.cc.

std::string VacuumGripperPlugin::Name

(

)

const

Return the name of the gripper.

Definition at line 334 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::OnContacts

(

ConstContactsPtr &

_msg

)

[private]

Callback used when the gripper contacts an object.

Parameters:

[in]

_msg

Message that contains contact information.

Definition at line 427 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::OnUpdate

(

)

[private]

Update the gripper.

Definition at line 369 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::Publish

(

)

const [private, virtual]

Overwrite this method for sending periodic updates with the gripper state.

Reimplemented in gazebo::ROSVacuumGripperPlugin.

Definition at line 527 of file VacuumGripperPlugin.cc.

void VacuumGripperPlugin::Reset

(

)

[virtual]

Documentation inherited.

Reimplemented in gazebo::ROSVacuumGripperPlugin.

Definition at line 324 of file VacuumGripperPlugin.cc.

---

Member Data Documentation

std::unique_ptr<VacuumGripperPluginPrivate> gazebo::VacuumGripperPlugin::dataPtr [private]

Reimplemented in gazebo::ROSVacuumGripperPlugin.

Definition at line 85 of file VacuumGripperPlugin.hh.

---

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

• VacuumGripperPlugin.hh
• VacuumGripperPlugin.cc