Public Member Functions | Public Attributes | List of all members
rosman.DocTopicReader Class Reference

Public Member Functions

def __init__ (self, rosmaster)
 
def doc_topic_callback (self, doc_msg)
 
def get_doc_msg_param (self, input_param)
 
def get_doc_msg_service (self, input_service)
 
def get_doc_msg_topic (self, input_topic)
 
def read_doc_topic (self, topic, timeout_duration=2.0)
 
def write_node_documentation (self, output_file=sys.stdout)
 
def write_node_header_documentation (self, output_file=sys.stdout)
 
def write_node_parameters_documentation (self, output_file, data)
 
def write_node_publishers_documentation (self, output_file, data)
 
def write_node_services_documentation (self, output_file, data)
 
def write_node_subscriptions_documentation (self, output_file, data)
 
def write_param_info_docstring (self, param_info_msg, output_file=sys.stdout)
 
def write_service_info_docstring (self, service_info_msg, output_file=sys.stdout)
 
def write_topic_info_docstring (self, topic_info_msg, output_file=sys.stdout)
 

Public Attributes

 callback_called
 
 last_doc_msg
 
 rosmaster
 

Detailed Description

Definition at line 34 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def rosman.DocTopicReader.__init__ (   self,
  rosmaster 
)

Definition at line 35 of file __init__.py.

Member Function Documentation

◆ doc_topic_callback()

def rosman.DocTopicReader.doc_topic_callback (   self,
  doc_msg 
)

Definition at line 43 of file __init__.py.

◆ get_doc_msg_param()

def rosman.DocTopicReader.get_doc_msg_param (   self,
  input_param 
)

Definition at line 222 of file __init__.py.

◆ get_doc_msg_service()

def rosman.DocTopicReader.get_doc_msg_service (   self,
  input_service 
)

Definition at line 230 of file __init__.py.

◆ get_doc_msg_topic()

def rosman.DocTopicReader.get_doc_msg_topic (   self,
  input_topic 
)

Definition at line 214 of file __init__.py.

◆ read_doc_topic()

def rosman.DocTopicReader.read_doc_topic (   self,
  topic,
  timeout_duration = 2.0 
)

Definition at line 47 of file __init__.py.

◆ write_node_documentation()

def rosman.DocTopicReader.write_node_documentation (   self,
  output_file = sys.stdout 
)

Definition at line 59 of file __init__.py.

◆ write_node_header_documentation()

def rosman.DocTopicReader.write_node_header_documentation (   self,
  output_file = sys.stdout 
)

Definition at line 108 of file __init__.py.

◆ write_node_parameters_documentation()

def rosman.DocTopicReader.write_node_parameters_documentation (   self,
  output_file,
  data 
)

Definition at line 134 of file __init__.py.

◆ write_node_publishers_documentation()

def rosman.DocTopicReader.write_node_publishers_documentation (   self,
  output_file,
  data 
)

Definition at line 126 of file __init__.py.

◆ write_node_services_documentation()

def rosman.DocTopicReader.write_node_services_documentation (   self,
  output_file,
  data 
)

Definition at line 142 of file __init__.py.

◆ write_node_subscriptions_documentation()

def rosman.DocTopicReader.write_node_subscriptions_documentation (   self,
  output_file,
  data 
)

Definition at line 113 of file __init__.py.

◆ write_param_info_docstring()

def rosman.DocTopicReader.write_param_info_docstring (   self,
  param_info_msg,
  output_file = sys.stdout 
)

Definition at line 159 of file __init__.py.

◆ write_service_info_docstring()

def rosman.DocTopicReader.write_service_info_docstring (   self,
  service_info_msg,
  output_file = sys.stdout 
)

Definition at line 210 of file __init__.py.

◆ write_topic_info_docstring()

def rosman.DocTopicReader.write_topic_info_docstring (   self,
  topic_info_msg,
  output_file = sys.stdout 
)

Definition at line 121 of file __init__.py.

Member Data Documentation

◆ callback_called

rosman.DocTopicReader.callback_called

Definition at line 37 of file __init__.py.

◆ last_doc_msg

rosman.DocTopicReader.last_doc_msg

Definition at line 38 of file __init__.py.

◆ rosmaster

rosman.DocTopicReader.rosmaster

Definition at line 36 of file __init__.py.


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


swri_cli_tools
Author(s): Robert Brothers
autogenerated on Thu Feb 27 2025 03:33:55