Public Member Functions | Static Public Attributes | Private Attributes | List of all members
rosbridge_library.capabilities.advertise.Advertise Class Reference
Inheritance diagram for rosbridge_library.capabilities.advertise.Advertise:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, protocol)
 
def advertise (self, message)
 
def finish (self)
 
def unadvertise (self, message)
 
- 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 advertise_msg_fields = [(True, "topic", string_types), (True, "type", string_types)]
 
 topics_glob = None
 
list unadvertise_msg_fields = [(True, "topic", string_types)]
 

Private Attributes

 _registrations
 

Additional Inherited Members

- Public Attributes inherited from rosbridge_library.capability.Capability
 protocol
 

Detailed Description

Definition at line 75 of file advertise.py.

Constructor & Destructor Documentation

◆ __init__()

def rosbridge_library.capabilities.advertise.Advertise.__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 82 of file advertise.py.

Member Function Documentation

◆ advertise()

def rosbridge_library.capabilities.advertise.Advertise.advertise (   self,
  message 
)

Definition at line 96 of file advertise.py.

◆ finish()

def rosbridge_library.capabilities.advertise.Advertise.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 159 of file advertise.py.

◆ unadvertise()

def rosbridge_library.capabilities.advertise.Advertise.unadvertise (   self,
  message 
)

Definition at line 128 of file advertise.py.

Member Data Documentation

◆ _registrations

rosbridge_library.capabilities.advertise.Advertise._registrations
private

Definition at line 91 of file advertise.py.

◆ advertise_msg_fields

list rosbridge_library.capabilities.advertise.Advertise.advertise_msg_fields = [(True, "topic", string_types), (True, "type", string_types)]
static

Definition at line 77 of file advertise.py.

◆ topics_glob

rosbridge_library.capabilities.advertise.Advertise.topics_glob = None
static

Definition at line 80 of file advertise.py.

◆ unadvertise_msg_fields

list rosbridge_library.capabilities.advertise.Advertise.unadvertise_msg_fields = [(True, "topic", string_types)]
static

Definition at line 78 of file advertise.py.


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


rosbridge_library
Author(s): Jonathan Mace
autogenerated on Tue Oct 3 2023 02:12:45