ShowLog Class Reference

This plugin registers a number of LogWriters at the Log component such that any output written to info, warning or error logs will be routed to the window of this plugin. More...

#include <ShowLog.hpp>

Inherits RobWorkStudioPlugin.

Public Member Functions
	ShowLog ()
	constructor
	~ShowLog ()
	destructor
void	open (rw::models::WorkCell *workcell)
	called when a workcell is opened More...
void	close ()
	called when a workcell is being closed. More...
void	frameSelectedListener (rw::kinematics::Frame *frame)
	not implemented yet!
void	initialize ()
	not implemented yet!
void	receiveMessage (const std::string &plugin, const std::string &id, const rw::core::Message &msg)
	listener for messages from other plugins More...
void	write (const std::string &str, const QColor &color)
	Write to the log window. More...
void	flush ()
	Clear the log window.
bool	event (QEvent *event)
	Handle Qt event. 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

Additional Inherited Members
Public Slots inherited from RobWorkStudioPlugin
void	showPlugin ()
	toggles the visibility of the plugin
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...
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

This plugin registers a number of LogWriters at the Log component such that any output written to info, warning or error logs will be routed to the window of this plugin.

Member Function Documentation

close()

void close ( )

virtual

called when a workcell is being closed.

Reimplemented from RobWorkStudioPlugin.

event()

bool event

(

QEvent *

event

)

Handle Qt event.

Parameters

event

[in] the event.

Returns

true if handled, false otherwise.

open()

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

virtual

called when a workcell is opened

Parameters

workcell

[in] that has been loaded

Reimplemented from RobWorkStudioPlugin.

receiveMessage()

void receiveMessage	(	const std::string &	plugin,
		const std::string &	id,
		const rw::core::Message &	msg
	)

listener for messages from other plugins

Parameters

plugin
id
msg

write()

void write	(	const std::string &	str,
		const QColor &	color
	)

Write to the log window.

Parameters

str	[in] the string to write.
color	[in] color of text.

---

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

• ShowLog.hpp