rosbridge_library.capabilities.subscribe.Subscribe Class Reference

Inheritance diagram for rosbridge_library.capabilities.subscribe.Subscribe:

Public Member Functions
def	__init__ (self, protocol)
def	finish (self)
def	publish (self, topic, message, fragment_size=None, compression="none")
def	subscribe (self, msg)
def	unsubscribe (self, msg)
Public Member Functions inherited from rosbridge_library.capability.Capability
def	basic_type_check (self, msg, types_info)
def	handle_message (self, message)

Static Public Attributes
list	subscribe_msg_fields
	topics_glob = None
list	unsubscribe_msg_fields = [(True, "topic", string_types)]

Private Attributes
	_subscriptions

Additional Inherited Members
Public Attributes inherited from rosbridge_library.capability.Capability
	protocol

Detailed Description

Definition at line 195 of file subscribe.py.

Constructor & Destructor Documentation

__init__()

def rosbridge_library.capabilities.subscribe.Subscribe.__init__	(		self,
			protocol
	)

Abstract class constructor.  All capabilities require a handle to
the containing protocol.

Keyword arguments:
protocol -- the protocol instance for this capability instance

Reimplemented from rosbridge_library.capability.Capability.

Definition at line 204 of file subscribe.py.

Member Function Documentation

finish()

def rosbridge_library.capabilities.subscribe.Subscribe.finish

(

self

)

Notify this capability that the client is finished and that it's
time to free up resources. 

Reimplemented from rosbridge_library.capability.Capability.

Definition at line 302 of file subscribe.py.

publish()

def rosbridge_library.capabilities.subscribe.Subscribe.publish	(		self,
			topic,
			message,
			fragment_size = None,
			compression = "none"
	)

Publish a message to the client

Keyword arguments:
topic   -- the topic to publish the message on
message -- a ROS message wrapped by OutgoingMessage
fragment_size -- (optional) fragment the serialized message into msgs
with payloads not greater than this value
compression   -- (optional) compress the message. valid values are
'png' and 'none'

Definition at line 274 of file subscribe.py.

subscribe()

def rosbridge_library.capabilities.subscribe.Subscribe.subscribe	(		self,
			msg
	)

Definition at line 214 of file subscribe.py.

unsubscribe()

def rosbridge_library.capabilities.subscribe.Subscribe.unsubscribe	(		self,
			msg
	)

Definition at line 256 of file subscribe.py.

Member Data Documentation

_subscriptions

rosbridge_library.capabilities.subscribe.Subscribe._subscriptions

private

Definition at line 212 of file subscribe.py.

subscribe_msg_fields

list rosbridge_library.capabilities.subscribe.Subscribe.subscribe_msg_fields

static

Initial value:

=  [(True, "topic", string_types), (False, "type", string_types),
                            (False, "throttle_rate", int), (False, "fragment_size", int),
                            (False, "queue_length", int), (False, "compression", string_types)]

Definition at line 197 of file subscribe.py.

topics_glob

rosbridge_library.capabilities.subscribe.Subscribe.topics_glob = None

static

Definition at line 202 of file subscribe.py.

unsubscribe_msg_fields

list rosbridge_library.capabilities.subscribe.Subscribe.unsubscribe_msg_fields = [(True, "topic", string_types)]

static

Definition at line 200 of file subscribe.py.

---

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

• subscribe.py