interactive_markers::interactive_marker_server::InteractiveMarkerServer Class Reference

Acts as a server displaying a set of interactive markers. More...

Public Member Functions
def	__del__
	Destruction of the interface will lead to all managed markers being cleared.
def	__init__
	Create an InteractiveMarkerServer and associated ROS connections.
def	applyChanges
	Apply changes made since the last call to this method & broadcast an update to all clients.
def	clear
	Clear all markers.
def	doSetPose
def	erase
	Erase the marker with the specified name Note: This change will not take effect until you call applyChanges().
def	get
	Get marker by name.
def	insert
	Add or replace a marker.
def	keepAlive
def	processFeedback
def	publish
def	publishInit
def	setCallback
	Add or replace a callback function for the specified marker.
def	setPose
	Update the pose of a marker with the specified name Note: This change will not take effect until you call applyChanges().
Public Attributes
	init_pub
	marker_contexts
	mutex
	pending_updates
	seq_num
	server_id
	topic_ns
	update_pub
Static Public Attributes
int	DEFAULT_FEEDBACK_CB = 255

Detailed Description

Acts as a server displaying a set of interactive markers.

Note: Keep in mind that changes made by calling insert(), erase(), setCallback() etc. are not applied until calling applyChanges().

Definition at line 68 of file interactive_marker_server.py.

Member Function Documentation

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::__del__ ( self )

Destruction of the interface will lead to all managed markers being cleared.

Definition at line 101 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::__init__	(	self,
		topic_ns,
		server_id = `""`,
		q_size = `100`
	)

Create an InteractiveMarkerServer and associated ROS connections.

Parameters:

	topic_ns	The interface will use the topics topic_ns/update and topic_ns/feedback for communication.
	server_id	If you run multiple servers on the same topic from within the same node, you will need to assign different names to them. Otherwise, leave this empty.

Definition at line 77 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::applyChanges ( self )

Apply changes made since the last call to this method & broadcast an update to all clients.

Definition at line 224 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::clear ( self )

Clear all markers.

Note: This change will not take effect until you call applyChanges().

Definition at line 174 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::doSetPose	(	self,
		update,
		name,
		pose,
		header
	)

Definition at line 367 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::erase	(	self,
		name
	)

Erase the marker with the specified name Note: This change will not take effect until you call applyChanges().

Parameters:

name

Name of the interactive marker

Returns:: True if a marker with that name exists

Definition at line 157 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::get	(	self,
		name
	)

Get marker by name.

Parameters:

name

Name of the interactive marker

Returns:: Marker if exists, None otherwise

Definition at line 276 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::insert	(	self,
		marker,
		feedback_cb = `-1`,
		feedback_type = `DEFAULT_FEEDBACK_CB`
	)

Add or replace a marker.

Note: Changes to the marker will not take effect until you call applyChanges(). The callback changes immediately.

Parameters:

	marker	The marker to be added or replaced
	feedback_cb	Function to call on the arrival of a feedback message.
	feedback_type	Type of feedback for which to call the feedback.

Definition at line 111 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::keepAlive	(	self,
		msg
	)

Definition at line 342 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::processFeedback	(	self,
		feedback
	)

Definition at line 302 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::publish	(	self,
		update
	)

Definition at line 348 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::publishInit ( self )

Definition at line 354 of file interactive_marker_server.py.

def interactive_markers::interactive_marker_server::InteractiveMarkerServer::setCallback	(	self,
		name,
		feedback_cb,
		feedback_type = `DEFAULT_FEEDBACK_CB`
	)

Add or replace a callback function for the specified marker.

Note: This change will not take effect until you call applyChanges(). The server will try to call any type-specific callback first. If none is set, it will call the default callback. If a callback for the given type already exists, it will be replaced. To unset a type-specific callback, pass in an empty one.

Parameters:

	name	Name of the interactive marker
	feedback_cb	Function to call on the arrival of a feedback message.
	feedback_type	Type of feedback for which to call the feedback. Leave this empty to make this the default callback.

Definition at line 188 of file interactive_marker_server.py.