Functions | Variables
rosapi.objectutils Namespace Reference

Functions

def _get_special_typedef (type)
 
def _get_subtypedefs_recursive (typedef, typesseen)
 
def _get_typedef (instance)
 
def _get_typedefs_recursive (type, typesseen)
 
def _type_name (type, instance)
 
def _type_name_from_instance (instance)
 
def get_service_request_typedef (servicetype)
 
def get_service_request_typedef_recursive (servicetype)
 
def get_service_response_typedef (servicetype)
 
def get_service_response_typedef_recursive (servicetype)
 
def get_typedef (type)
 
def get_typedef_full_text (type)
 
def get_typedef_recursive (type)
 

Variables

list atomics = ['bool', 'byte','int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32', 'int64', 'uint64', 'float32', 'float64', 'string']
 
list specials = ['time', 'duration']
 

Function Documentation

def rosapi.objectutils._get_special_typedef (   type)
private

Definition at line 167 of file objectutils.py.

def rosapi.objectutils._get_subtypedefs_recursive (   typedef,
  typesseen 
)
private

Definition at line 195 of file objectutils.py.

def rosapi.objectutils._get_typedef (   instance)
private
Gets a typedef dict for the specified instance 

Definition at line 107 of file objectutils.py.

def rosapi.objectutils._get_typedefs_recursive (   type,
  typesseen 
)
private
returns the type def for this type as well as the type defs for any fields within the type 

Definition at line 181 of file objectutils.py.

def rosapi.objectutils._type_name (   type,
  instance 
)
private
given a short type, and an object instance of that type,
determines and returns the fully qualified type 

Definition at line 206 of file objectutils.py.

def rosapi.objectutils._type_name_from_instance (   instance)
private

Definition at line 221 of file objectutils.py.

def rosapi.objectutils.get_service_request_typedef (   servicetype)
Returns a typedef dict for the service request class for the specified service type 

Definition at line 63 of file objectutils.py.

def rosapi.objectutils.get_service_request_typedef_recursive (   servicetype)
Returns a list of typedef dicts for this type and all contained type fields 

Definition at line 80 of file objectutils.py.

def rosapi.objectutils.get_service_response_typedef (   servicetype)
Returns a typedef dict for the service response class for the specified service type 

Definition at line 69 of file objectutils.py.

def rosapi.objectutils.get_service_response_typedef_recursive (   servicetype)
Returns a list of typedef dicts for this type and all contained type fields 

Definition at line 89 of file objectutils.py.

def rosapi.objectutils.get_typedef (   type)
A typedef is a dict containing the following fields:
     - string type
     - string[] fieldnames
     - string[] fieldtypes
     - int[] fieldarraylen
     - string[] examples
     - string[] constnames
     - string[] constvalues
get_typedef will return a typedef dict for the specified message type 

Definition at line 41 of file objectutils.py.

def rosapi.objectutils.get_typedef_full_text (   type)
Returns the full text (similar to `gendeps --cat`) for the specified message type 

Definition at line 98 of file objectutils.py.

def rosapi.objectutils.get_typedef_recursive (   type)
Returns a list of typedef dicts for this type and all contained type fields 

Definition at line 75 of file objectutils.py.

Variable Documentation

list rosapi.objectutils.atomics = ['bool', 'byte','int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32', 'int64', 'uint64', 'float32', 'float64', 'string']

Definition at line 38 of file objectutils.py.

list rosapi.objectutils.specials = ['time', 'duration']

Definition at line 39 of file objectutils.py.



rosapi
Author(s): Jonathan Mace
autogenerated on Wed Jun 3 2020 03:55:16