geodesy.props

geographic_msgs/KeyValue property interface for Geographic Information messages.

geodesy.props.get(msg, key)

Get property value.

Parameters:
  • msg – Message containing properties.

  • key – Property key to match.

Returns:

Corresponding value, if defined; None otherwise. Beware: the value may be ‘’, which evaluates False as a predicate, use is not None to test for presence.

geodesy.props.match(msg, key_set)

Match message properties.

Parameters:
  • msg – Message containing properties.

  • key_set – Set of property keys to match.

Returns:

(key, value) of first property matched; None otherwise.

Raises:

ValueError if key_set is not a set

geodesy.props.put(msg, key, val='')

Add KeyValue to message properties.

Parameters:
  • msg – Message to update.

  • key – Property key name.

  • value – Corresponding value string (default ‘’).