Skip to content

RosParameterProps

Initializer

import ros_cdk_core
ros_cdk_core.RosParameterProps(
  allowed_pattern: str = None,
  allowed_values: typing.List[typing.Any] = None,
  association_property: str = None,
  association_property_metadata: typing.Mapping[typing.Any] = None,
  confirm: bool = None,
  constraint_description: typing.Union[str, typing.Mapping[str]] = None,
  default_value: typing.Any = None,
  description: typing.Union[str, typing.Mapping[str]] = None,
  label: str = None,
  max_length: typing.Union[int, float] = None,
  max_value: typing.Union[int, float] = None,
  min_length: typing.Union[int, float] = None,
  min_value: typing.Union[int, float] = None,
  no_echo: bool = None,
  placeholder: typing.Union[str, typing.Mapping[str]] = None,
  required: bool = None,
  text_area: bool = None,
  type: RosParameterType = None
)

Properties

Name Type Description
allowed_pattern str No description.
allowed_values typing.List[typing.Any] No description.
association_property str No description.
association_property_metadata typing.Mapping[typing.Any] No description.
confirm bool No description.
constraint_description typing.Union[str, typing.Mapping[str]] No description.
default_value typing.Any No description.
description typing.Union[str, typing.Mapping[str]] No description.
label str No description.
max_length typing.Union[int, float] No description.
max_value typing.Union[int, float] No description.
min_length typing.Union[int, float] No description.
min_value typing.Union[int, float] No description.
no_echo bool No description.
placeholder typing.Union[str, typing.Mapping[str]] No description.
required bool No description.
text_area bool No description.
type RosParameterType No description.

allowed_patternOptional

allowed_pattern: str
  • Type: str

allowed_valuesOptional

allowed_values: typing.List[typing.Any]
  • Type: typing.List[typing.Any]

association_propertyOptional

association_property: str
  • Type: str

association_property_metadataOptional

association_property_metadata: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

confirmOptional

confirm: bool
  • Type: bool

constraint_descriptionOptional

constraint_description: typing.Union[str, typing.Mapping[str]]
  • Type: typing.Union[str, typing.Mapping[str]]

default_valueOptional

default_value: typing.Any
  • Type: typing.Any

descriptionOptional

description: typing.Union[str, typing.Mapping[str]]
  • Type: typing.Union[str, typing.Mapping[str]]

labelOptional

label: str
  • Type: str

max_lengthOptional

max_length: typing.Union[int, float]
  • Type: typing.Union[int, float]

max_valueOptional

max_value: typing.Union[int, float]
  • Type: typing.Union[int, float]

min_lengthOptional

min_length: typing.Union[int, float]
  • Type: typing.Union[int, float]

min_valueOptional

min_value: typing.Union[int, float]
  • Type: typing.Union[int, float]

no_echoOptional

no_echo: bool
  • Type: bool

placeholderOptional

placeholder: typing.Union[str, typing.Mapping[str]]
  • Type: typing.Union[str, typing.Mapping[str]]

requiredOptional

required: bool
  • Type: bool

text_areaOptional

text_area: bool
  • Type: bool

typeOptional

type: RosParameterType