Util

exception bosdyn.mission.util.Error

Bases: Exception

exception bosdyn.mission.util.InvalidConversion(original_value, destination_typename)

Bases: Error

Could not convert the provided value to the destination type.

bosdyn.mission.util.tree_to_string(root, start_level=0, include_status=False)

Get a string representation of a Node, interpreted as a tree.

bosdyn.mission.util.type_to_field_name(type_name)

Use type name to reconstruct field name of bosdyn.api.mission.Node.type Example: SimpleParallel becomes simple_parallel

bosdyn.mission.util.proto_from_tuple(tup, pack_nodes=True)

Return a bosdyn.api.mission Node from a tuple. EXPERIMENTAL.

Example: :: (‘do-A-then-B’, bosdyn.api.mission.nodes_pb2.Sequence(always_restart=True), [ (‘A’, foo.bar.Command(…), []), (‘B’, foo.bar.Command(…), []), ] ) would make a Sequence named ‘do-A-then-B’ that always restarted, executing some Command named ‘A’ followed by the Command named ‘B’. NOTE: The “List of children tuples” will only work if the parent node has ‘child’ or ‘children’ attributes. See tests/test_util.py for a longer example.

Parameters:

tup – (Name of node, Instantiated implementation of node protobuf, List of children tuples)

bosdyn.mission.util.python_var_to_value(var)

Returns a ConstantValue with the appropriate oneof set.

bosdyn.mission.util.python_type_to_pb_type(var)

Returns the protobuf-schema variable type that corresponds to the given variable.

bosdyn.mission.util.is_string_identifier(string)

bosdyn.mission.util.field_desc_to_pb_type(field_desc)

Returns the protobuf-schema variable type that corresponds to the given descriptor.

bosdyn.mission.util.safe_pb_type_to_string(pb_type)

Return the stringified VariableDeclaration.Type, or “<unknown>” if the type is invalid.

bosdyn.mission.util.one_line_str(msg)

bosdyn.mission.util.node_spec_to_short_string(node_spec, maxlen=15)

class bosdyn.mission.util.ResultFromProto

Bases: object

results_from_proto = {1: Result.FAILURE, 2: Result.RUNNING, 3: Result.SUCCESS, 4: Result.ERROR}

proto_from_results = {Result.FAILURE: 1, Result.RUNNING: 2, Result.SUCCESS: 3, Result.ERROR: 4}

bosdyn.mission.util.proto_enum_to_result_constant(proto_msg)

Returns a Result enum from a util_pb2.Result, or throws InvalidConversion error.

bosdyn.mission.util.result_constant_to_proto_enum(result)

Returns a protobuf version of the Result enum, RESULT_UNKNOWN on error.

bosdyn.mission.util.most_restrictive_travel_params(travel_params, vel_limit=None, disable_directed_exploration=False, disable_alternate_route_finding=False, path_following_mode=None, ground_clutter_mode=None)

bosdyn.mission.util.get_value_from_constant_value_message(const_proto)

bosdyn.mission.util.get_value_from_value_message(node, blackboard, value_msg, is_validation=False)

bosdyn.mission.util.create_value(var: bool | int | float | str | Message) → Value

Returns a Value message containing a ConstantValue with the appropriate oneof set.

bosdyn.mission.util.define_blackboard(dict_values: Dict[str, Value]) → DefineBlackboard

Returns a DefineBlackboard protobuf message for the key-value pairs in dict_values.

bosdyn.mission.util.set_blackboard(dict_values: Dict[str, Value], subfield_values: Dict[str, Value] = {}) → SetBlackboard

Returns a SetBlackboard protobuf message for the key-value pairs in dict_values.

bosdyn.mission.util.severity_to_log_level(text_level)

Converts alert data severity enum to a logger level for printing purposes.