niryo_libraries.roslib.msgs.MsgSpec

class documentation

class MsgSpec(object):

Constructor: MsgSpec(types, names, constants, text, ...)

View In Hierarchy

Container class for storing loaded msg description files. Field types and names are stored in separate lists with 1-to-1 correspondence. MsgSpec can also return an md5 of the source text.

Method __eq__ Undocumented
Method __init__ @param types: list of field types, in order of declaration @type types: [str] @param names: list of field names, in order of declaration @type names: [str] @param constants: Constant declarations @type constants: [L{Constant}] @param text: text of declaration @type text: str @raise MsgSpecException: if spec is invalid (e...
Method __ne__ Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method fields @return: zip list of types and names (e.g. [('int32', 'x'), ('int32', 'y')] @rtype: [(str,str),]
Method has_header @return: True if msg description contains a 'Header header' declaration at the beginning @rtype: bool
Method parsed_fields @return: list of Field classes @rtype: [Field,]
Instance Variable constants Undocumented
Instance Variable full_name Undocumented
Instance Variable header_present Undocumented
Instance Variable names Undocumented
Instance Variable package Undocumented
Instance Variable short_name Undocumented
Instance Variable text Undocumented
Instance Variable types Undocumented
Instance Variable _parsed_fields Undocumented
def __eq__(self, other):

Undocumented

def __init__(self, types, names, constants, text, full_name='', short_name='', package=''):

@param types: list of field types, in order of declaration @type types: [str] @param names: list of field names, in order of declaration @type names: [str] @param constants: Constant declarations @type constants: [L{Constant}] @param text: text of declaration @type text: str @raise MsgSpecException: if spec is invalid (e.g. fields with the same name)

def __ne__(self, other):

Undocumented

def __repr__(self):

Undocumented

def __str__(self):

Undocumented

def fields(self):

@return: zip list of types and names (e.g. [('int32', 'x'), ('int32', 'y')] @rtype: [(str,str),]

def has_header(self):

@return: True if msg description contains a 'Header header' declaration at the beginning @rtype: bool

def parsed_fields(self):

@return: list of Field classes @rtype: [Field,]

constants =

Undocumented

full_name =

Undocumented

header_present =

Undocumented

names =

Undocumented

package =

Undocumented

short_name =

Undocumented

text =

Undocumented

types =

Undocumented

_parsed_fields =

Undocumented