Classes
class	BagMigrationException
class	MessageMigrator
	A class to actually migrate messages. More...
class	MessageUpdateRule
	Base class for all message update rules. More...
class	RuleChain
	A class for book-keeping about rule-chains. More...
class	ScaffoldNode
	A class for arranging the ordered rules. More...
Functions
def	checkbag
def	checkmessages
def	clean_name
	Helper function to strip out roslib and package name from name usages.
def	constants_from_def
def	fixbag
	Fix a bag so that it can be played in the current system.
def	fixbag2
	Fix a bag so that it can be played in the current system.
def	get_message_key
	Helper function to return a key from a given class.
def	get_path_key
	Helper function to return a key for a given path.
def	migration_default_value
def	qualified_name
	Helper function to ensure we end up with a qualified name.

Function Documentation

def rosbag.migration.checkbag	(	migrator,
		inbag
	)

Check whether a bag file can be played in the current system.
@param migrator: message migrator to use
@param inbag name of the bag to be checked.
@returns A list of tuples for each type in the bag file.  The first
element of each tuple is the full migration path for the type.  The
second element of the tuple is the expanded list of invalid rules
for that particular path.

Definition at line 59 of file migration.py.

def rosbag.migration.checkmessages	(	migrator,
		messages
	)

Check whether a bag file can be played in the current system.
@param migrator The message migrator to use
@param message_list A list of message classes.
@returns A list of tuples for each type in the bag file.  The first
element of each tuple is the full migration path for the type.  The
second element of the tuple is the expanded list of invalid rules
for that particular path.

Definition at line 90 of file migration.py.

def rosbag.migration.clean_name	(	name,
		top_name
	)

Helper function to strip out roslib and package name from name usages.

There is some inconsistency in whether a fully-qualified path is used for sub-messages within a given message. This function is useful for stripping out the package name in a fully qualified sub-message.

Parameters:

name	The name to clean.
top_name	The name of the top-level type

Returns:: The cleaned version of the name.

Definition at line 183 of file migration.py.

def rosbag.migration.constants_from_def	(	core_type,
		msg_def
	)

Definition at line 1313 of file migration.py.

def rosbag.migration.fixbag	(	migrator,
		inbag,
		outbag
	)

Fix a bag so that it can be played in the current system.

Parameters:

migrator	The message migrator to use
inbag	Name of the bag to be fixed.
outbag	Name of the bag to be saved.

Returns:: True if migration was successful.

Definition at line 124 of file migration.py.

def rosbag.migration.fixbag2	(	migrator,
		inbag,
		outbag,
		force = `False`
	)

Fix a bag so that it can be played in the current system.

Parameters:

migrator	The message migrator to use
inbag	Name of the bag to be fixed.
outbag	Name of the bag to be saved.

Returns:: [] if bag could be migrated, otherwise, it returns the list of necessary migration paths

Definition at line 148 of file migration.py.

def rosbag.migration.get_message_key ( c )

Helper function to return a key from a given class.

For now, we choose the tuple (type,md5sum) as a unique key for the class. However, this is subject to change and assumptions about keys should not be made other than their uniqueness.

Parameters:

c	The message class or instance to get a key for

Returns:: The unique key

Definition at line 224 of file migration.py.

def rosbag.migration.get_path_key	(	c1,
		c2
	)

Helper function to return a key for a given path.

For now, we choose the tuple ((type1,md5sum1),(type2,md5sum2)) as a unique key for the path. However, this is subject to change and assumptions about keys should not be made other than their uniqueness.

Parameters:

c1	The start point of the path
c1	The stop point of the path

Returns:: The unique key

Definition at line 240 of file migration.py.

def rosbag.migration.migration_default_value ( field_type )

Definition at line 1288 of file migration.py.

def rosbag.migration.qualified_name	(	name,
		top_name
	)

Helper function to ensure we end up with a qualified name.

There is some inconsistency in whether a fully-qualified path is used for sub-messages within a given message. This function is useful for ensuring that a name is fully qualified correctly.

Parameters:

name	The name to quailfy
top_name	The name of the top-level type

Returns:: The qualified version of the name.

Definition at line 205 of file migration.py.

Classes

Functions

Function Documentation