niryo_libraries.genmsg.msgs.MsgSpec

class documentation

class MsgSpec(object):

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

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__`	No summary
Method	`__ne__`	Undocumented
Method	`__repr__`	Undocumented
Method	`__str__`	Undocumented
Method	`fields`	No summary
Method	`has_header`	No summary
Method	`parsed_fields`	No summary
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, package='', short_name=''): ¶

Parameters
types	list of field types, in order of declaration, `[str]`
names	list of field names, in order of declaration, `[str]`
constants	List of `Constant` declarations, `[Constant]`
text	text of declaration, `str`
full_name	Undocumented
package	Undocumented
short_name	Undocumented
Raises
`Unknown exception`	`InvalidMsgSpec` 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): ¶

Returns
zip list of types and names (e.g. [('int32', 'x'), ('int32', 'y')], `[(str,str),]`

def has_header(self): ¶

Returns
`True` if msg decription contains a 'Header header' declaration at the beginning, `bool`

def parsed_fields(self): ¶

Returns
list of `Field` classes, `[Field,]`

constants = ¶

Undocumented

full_name = ¶

Undocumented

header_present = ¶

Undocumented

names = ¶

Undocumented

package = ¶

Undocumented

short_name = ¶

Undocumented

text = ¶

Undocumented

types = ¶

Undocumented

_parsed_fields = ¶

Undocumented