launch_ros.parameter_descriptions module

Module for a description of a Parameter.

class launch_ros.parameter_descriptions.Parameter(name: launch.SomeSubstitutionsType, value: launch.utilities.type_utils.SomeValueType, *, value_type: launch.utilities.type_utils.AllowedTypesType | None = None)

Bases: object

Describes a ROS parameter.

evaluate(context: launch.LaunchContext) → Tuple[str, EvaluatedParameterValue]

Evaluate and return parameter rule.

property name: List[launch.substitution.Substitution] | str

Getter for parameter name.

property value: launch.utilities.type_utils.SomeValueType

Getter for parameter value.

property value_type: launch.utilities.type_utils.AllowedTypesType

Getter for parameter value type.

class launch_ros.parameter_descriptions.ParameterFile(param_file: launch.utilities.typing_file_path.FilePath | launch.SomeSubstitutionsType, *, allow_substs: [<class 'bool'>, launch.SomeSubstitutionsType] = False)

Bases: object

Describes a ROS parameter file.

property allow_substs: bool | List[launch.substitution.Substitution]

Getter for allow substitutions argument.

cleanup()

Delete created temporary files.

evaluate(context: launch.LaunchContext) → Path

Evaluate and return a parameter file path.

property param_file: launch.utilities.typing_file_path.FilePath | List[launch.substitution.Substitution]

Getter for parameter file.

class launch_ros.parameter_descriptions.ParameterValue(value: launch.utilities.type_utils.SomeValueType, *, value_type: launch.utilities.type_utils.AllowedTypesType | None = None)

Bases: object

Describes a ROS parameter value.

evaluate(context: launch.LaunchContext) → EvaluatedParameterValue

Evaluate and return parameter rule.

property value: launch.utilities.type_utils.SomeValueType

Getter for parameter value.

property value_type: launch.utilities.type_utils.AllowedTypesType

Getter for parameter value type.