skbot.ignition.sdformat.loads_generic

skbot.ignition.sdformat.loads_generic(sdf)[source]

Turn a SDFormat string into an object tree.

The returned object tree is oppinionated. In addition to converting the tree, it does the following:

  • Some SDFormat elements are ignored/not implemented (contributions welcome!)

  • its variable names differ from SDFormat

    • If an element may have multiple children of the same kind, they corresponding attribute uses plural instead of singular, e.g. models instead of model.

    • If different SDF versions use different names for the same variable, they are converted into the name used in the most recent SDFormat version. Old names are still available via a @property and will raise a depreciation warning.

  • it converts all vectors to numpy arrays

  • it resolves includes, removes them, and inserts the included element

  • it appends __model__ to frame references where necessary

Parameters
sdfstr

A string containing SDFormat XML.

Returns
rootgeneric.Sdf

The root/sdf element of the generic SDF representation.

previous

skbot.ignition.sdformat.loads

next

skbot.ignition.sdformat.to_frame_graph