Jog Class Reference

The Jog plugin enables cartesean and joint level jogging of MovableFrames and Devices. Reference frame can freely be choosen and the devices are jogged using general inverse kinematic solvers. More...

#include <Jog.hpp>

Inherits RobWorkStudioPlugin.

Public Member Functions
	Jog ()
	Constructor.
virtual	~Jog ()
	Destructor.
virtual void	initialize ()
	is called when RobWorkStudio instance is valid. Can be used to initialize values in the plugin that depend on RobWorkStudio More...
virtual void	open (rw::models::WorkCell *workcell)
	called when a workcell is opened More...
virtual void	close ()
	called when a workcell is being closed. More...
void	frameSelectedListener (rw::kinematics::Frame *frame)
	not implemented yet
void	workcellChangedListener (int notUsed)
	Listen for change in workcell. More...
void	genericEventListener (const std::string &event)
	Listen for generic events: More...
Public Member Functions inherited from RobWorkStudioPlugin
	RobWorkStudioPlugin (const QString &name, const QIcon &icon)
	constructor of the plugin interface More...
virtual QString	name () const
	name that describe the plugin instance
virtual void	setupMenu (QMenu *menu)
	sets up the menu with this plugin More...
virtual void	setupToolBar (QToolBar *toolbar)
	setsup a toolbar with the actions of this plugin More...
virtual void	setRobWorkStudio (RobWorkStudio *studio)
	sets the RobWorkStudio instance of the plugin. Normally only done on construction.
virtual RobWorkStudio *	getRobWorkStudio ()
	returns a handle to the RobWorkStudio instance
virtual void	setRobWorkInstance (rw::core::RobWork::Ptr robwork)
	Sets the RobWork instance to be used by the plugin. More...
virtual rw::core::RobWork::Ptr	getRobWorkInstance ()
	Returns RobWork instance used by the plugin.
virtual rw::core::Log &	log ()
	returns the RobWorkStudio log instance
virtual void	setLog (rw::core::Log::Ptr log)
	Sets the log to use. More...
const rw::kinematics::State &	getState ()
	get current state of RobWorkStudio
void	setState (const rw::kinematics::State &state)
	set current state of RobWorkStudio

Protected Member Functions
void	showEvent (QShowEvent *event)
	Update the widget when it is shown. More...
Protected Member Functions inherited from RobWorkStudioPlugin
boost::tuple< QWidget *, QAction *, int >	getAction (QWidget *widget, const std::string &actionName)
	Find action in widget with name actionName . More...
boost::tuple< QWidget *, QMenu *, int >	getMenu (QWidget *widget, const std::string &menuName)
	Find menu in widget with name menuName . More...
boost::tuple< QMenu *, QAction *, int >	getAction (QWidget *widget, const std::string &actionName, const std::string &actionName2)
	Find action, actionName2, in menu, actionName, in a widget. More...

Additional Inherited Members
Public Slots inherited from RobWorkStudioPlugin
void	showPlugin ()
	toggles the visibility of the plugin
Protected Attributes inherited from RobWorkStudioPlugin
QAction	_showAction
	! More...
QString	_name
	! More...
RobWorkStudio *	_studio
	! More...
rw::core::RobWork::Ptr	_robwork
	! More...
rw::core::Log::Ptr	_log
	! More...

Detailed Description

The Jog plugin enables cartesean and joint level jogging of MovableFrames and Devices. Reference frame can freely be choosen and the devices are jogged using general inverse kinematic solvers.

Member Function Documentation

close()

virtual void close ( )

virtual

called when a workcell is being closed.

Reimplemented from RobWorkStudioPlugin.

genericEventListener()

void genericEventListener

(

const std::string &

event

)

Listen for generic events:

• WorkcellUpdated event makes Jog plugin refresh GUI to represent new workcell configuration (i.e. new frames & devices).

initialize()

virtual void initialize ( )

virtual

is called when RobWorkStudio instance is valid. Can be used to initialize values in the plugin that depend on RobWorkStudio

Note

DO NOT fire any events under initialization since the order of which plugins are initialized is unknown. Therefore undefined behavior might occour. Instead wait until open is called for the first time.

Reimplemented from RobWorkStudioPlugin.

open()

virtual void open ( rw::models::WorkCell *  workcell )

virtual

called when a workcell is opened

Parameters

workcell

[in] that has been loaded

Reimplemented from RobWorkStudioPlugin.

showEvent()

void showEvent ( QShowEvent *  event )

protected

Update the widget when it is shown.

Parameters

event

[in] the event (not used).

workcellChangedListener()

void workcellChangedListener

(

int

notUsed

)

Listen for change in workcell.

This method can be safely called from non-qt threads.

Parameters

notUsed

[in] not used.

---

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

• Jog.hpp