API Documentation: autosar_data.abstraction.ecu_configuration¶

ecu_configuration ¶

EcucAnyReferenceDef `module-attribute` ¶

EcucAnyReferenceDef: TypeAlias = Union[
    EcucReferenceDef,
    EcucUriReferenceDef,
    EcucForeignReferenceDef,
    EcucInstanceReferenceDef,
    EcucChoiceReferenceDef,
]

EcucContainerDef `module-attribute` ¶

EcucContainerDef: TypeAlias = Union[
    EcucParamConfContainerDef, EcucChoiceContainerDef
]

EcucParameterDef `module-attribute` ¶

EcucParameterDef: TypeAlias = Union[
    EcucAddInfoParamDef,
    EcucBooleanParamDef,
    EcucIntegerParamDef,
    EcucEnumerationParamDef,
    EcucFloatParamDef,
    EcucFunctionNameDef,
    EcucLinkerSymbolDef,
    EcucMultilineStringParamDef,
    EcucStringParamDef,
]

EcucParameterValue `module-attribute` ¶

EcucParameterValue: TypeAlias = Union[
    EcucNumericalParamValue,
    EcucTextualParamValue,
    EcucAddInfoParamValue,
]

EcucAddInfoParamDef ¶

EcucAddInfoParamDef(element: Element)

EcucAddInfoParamDef is used to specify the need for formated text in the ECU configuration value description

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

get or set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

get or set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucAddInfoParamValue ¶

EcucAddInfoParamValue(element: Element)

The EcucAddInfoParamValue holds descriptive text and takes the role of a parameter in the ECU configuration

element `instance-attribute` ¶

element: Element

EcucBooleanParamDef ¶

EcucBooleanParamDef(element: Element)

EcucBooleanParamDef is used to specify a boolean parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[bool]

set the default value of the boolean parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucChoiceContainerDef ¶

EcucChoiceContainerDef(element: Element)

Marker trait for container definitions The EcucChoiceContainerDef is used to define configuration containers that provide a choice between several EcucParamConfContainerDef

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

name `instance-attribute` ¶

name: str

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

choices ¶

choices() -> Iterator[EcucParamConfContainerDef]

iterate over the choices in the container

create_param_conf_container_def ¶

create_param_conf_container_def(
    name: str,
) -> EcucParamConfContainerDef

create a new EcucParamConfContainerDef as one of the choices in this choice container

EcucChoiceReferenceDef ¶

EcucChoiceReferenceDef(element: Element)

The EcucChoiceReferenceDef specifies alternative references where only one of the specified references will be used in the ECU configuration.

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

add_destination ¶

add_destination(destination) -> None

add a reference to a destination container

destination_refs ¶

destination_refs() -> Iterator[EcucContainerDef]

get the references to the destination containers

EcucConfigurationClass ¶

EcucConfigurationClass provides the different configuration classes for Autosar configuration parameters

Link `instance-attribute` ¶

Link: EcucConfigurationClass

PostBuild `instance-attribute` ¶

PostBuild: EcucConfigurationClass

PreCompile `instance-attribute` ¶

PreCompile: EcucConfigurationClass

PublishedInformation `instance-attribute` ¶

PublishedInformation: EcucConfigurationClass

EcucConfigurationVariant ¶

EcucConfigurationVariant provides the different configuration variants that can be used by the module definition.

PreconfiguredConfiguration `instance-attribute` ¶

PreconfiguredConfiguration: EcucConfigurationVariant

RecommendedConfiguration `instance-attribute` ¶

RecommendedConfiguration: EcucConfigurationVariant

VariantLinkTime `instance-attribute` ¶

VariantLinkTime: EcucConfigurationVariant

VariantPostBuild `instance-attribute` ¶

VariantPostBuild: EcucConfigurationVariant

VariantPostBuildLoadable `instance-attribute` ¶

VariantPostBuildLoadable: EcucConfigurationVariant

VariantPostBuildSelectable `instance-attribute` ¶

VariantPostBuildSelectable: EcucConfigurationVariant

VariantPreCompile `instance-attribute` ¶

VariantPreCompile: EcucConfigurationVariant

EcucContainerValue ¶

EcucContainerValue(element: Element)

The EcucContainerValue is a container in the ECU configuration

definition `instance-attribute` ¶

definition: Optional[EcucContainerDef]

set the container definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the definition reference as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

index `instance-attribute` ¶

index: Optional[int]

set the index of the container

If the container definition has requiresIndex set to true, then the container must have an index. Otherwise the index is meaningless.

name `instance-attribute` ¶

name: str

create_add_info_param_value ¶

create_add_info_param_value(
    definition: EcucAddInfoParamDef,
) -> EcucAddInfoParamValue

create a new EcucTextualParamValue in the container

create_instance_reference ¶

create_instance_reference(
    definition: EcucInstanceReferenceDef,
    target_context: List[Element],
    target: Element,
) -> EcucInstanceReferenceValue

create a new instance reference value in the container

create_numerical_param_value ¶

create_numerical_param_value(
    definition: EcucParameterDef, value: str
) -> EcucNumericalParamValue

create a new EcucNumericalParamValue in the container

create_reference_value ¶

create_reference_value(
    definition: EcucReferenceDef, target: Element
) -> EcucReferenceValue

create a new reference value in the container

create_sub_container ¶

create_sub_container(
    name: str, definition: EcucContainerDef
) -> EcucContainerValue

create a sub-container

create_textual_param_value ¶

create_textual_param_value(
    definition: EcucParameterDef, value: str
) -> EcucTextualParamValue

create a new EcucTextualParamValue in the container

parameter_values ¶

parameter_values() -> Iterator[EcucParameterValue]

iterate over the parameter values in the container

reference_values ¶

reference_values() -> Iterator[
    Union[EcucReferenceValue, EcucInstanceReferenceValue]
]

iterate over the reference values in the container

sub_containers ¶

sub_containers() -> Iterator[EcucContainerValue]

iterate over the sub-containers in this container

EcucDefinitionCollection ¶

EcucDefinitionCollection(element: Element)

The EcucDefinitionCollection is a container for all module definitions in the ECU configuration

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

add_module_def ¶

add_module_def(module_def: EcucModuleDef) -> None

add a reference to a module definition to the collection

module_defs ¶

module_defs() -> Iterator[EcucModuleDef]

iterate over all module definitions in the collection

EcucDestinationUriDef ¶

EcucDestinationUriDef(element: Element)

A EcucDestinationUriDef defines a target for an EcucUriReferenceDef

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

nesting_contract `instance-attribute` ¶

nesting_contract: Optional[
    EcucDestinationUriNestingContract
]

set the nesting contract for the destination uri

containers ¶

containers() -> Iterator[
    Union[EcucChoiceContainerDef, EcucParamConfContainerDef]
]

iterate over all containers in the destination uri policy

create_choice_container_def ¶

create_choice_container_def(
    name: str,
) -> EcucChoiceContainerDef

create an EcucChoiceContainerDef in the destination uri policy

create_param_conf_container_def ¶

create_param_conf_container_def(
    name: str,
) -> EcucParamConfContainerDef

create an EcucParamConfContainerDef in the destination uri policy

EcucDestinationUriDefSet ¶

EcucDestinationUriDefSet(element: Element)

A EcucDestinationUriDefSet contains a list of EcucDestinationUriDefs

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

create_destination_uri_def ¶

create_destination_uri_def(
    name: str, contract: EcucDestinationUriNestingContract
) -> EcucDestinationUriDef

create a new EcucDestinationUriDef

destination_uri_defs ¶

destination_uri_defs() -> Iterator[EcucDestinationUriDef]

iterate over all destination uri definitions in the set

EcucDestinationUriNestingContract ¶

EcucDestinationUriNestingContract provides the different nesting contracts for destination URIs

LeafOfTargetContainer `instance-attribute` ¶

LeafOfTargetContainer: EcucDestinationUriNestingContract

TargetContainer `instance-attribute` ¶

TargetContainer: EcucDestinationUriNestingContract

VertexOfTargetContainer `instance-attribute` ¶

VertexOfTargetContainer: EcucDestinationUriNestingContract

EcucEnumerationLiteralDef ¶

EcucEnumerationLiteralDef(element: Element)

EcucEnumerationLiteralDef is used to specify an enumeration literal in the ECU configuration

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

EcucEnumerationParamDef ¶

EcucEnumerationParamDef(element: Element)

EcucEnumerationParamDef is used to specify an enumeration parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[str]

set the default value of the enumeration parameter

Note: enumeration literals must be created first, since the default value must match one of the literals

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

create_enumeration_literal ¶

create_enumeration_literal(
    name,
) -> EcucEnumerationLiteralDef

create a new enumeration literal

enumeration_literals ¶

enumeration_literals() -> Iterator[
    EcucEnumerationLiteralDef
]

iterate over all enumeration literals

EcucFloatParamDef ¶

EcucFloatParamDef(element: Element)

EcucFloatParamDef is used to specify a float parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[float]

set the default value of the float parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max `instance-attribute` ¶

max: Optional[float]

set the max value of the float parameter

min `instance-attribute` ¶

min: Optional[float]

set the min value of the float parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucForeignReferenceDef ¶

EcucForeignReferenceDef(element: Element)

marker trait for all reference definitions The EcucForeignReferenceDef specifies a reference to an XML description of an entity described in another AUTOSAR template.

destination_type `instance-attribute` ¶

destination_type: Optional[str]

set the destination type of the reference definition

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucFunctionNameDef ¶

EcucFunctionNameDef(element: Element)

EcucFunctionNameDef is used to specify a function name parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[str]

default value of the string parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max_length `instance-attribute` ¶

max_length: Optional[int]

max length of the string parameter

min_length `instance-attribute` ¶

min_length: Optional[int]

min length of the string parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

regular_expression `instance-attribute` ¶

regular_expression: Optional[str]

regular expression for the string parameter

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucInstanceReferenceDef ¶

EcucInstanceReferenceDef(element: Element)

The EcucInstanceReferenceDef specifies a reference to an XML description of an entity described in another AUTOSAR template using INSTANCE REFERENCE semantics.

destination_context `instance-attribute` ¶

destination_context: Optional[str]

set the destination context of the reference definition

The destination context is a string of autosar element names separated by spaces. Additionally, the '' character can be used to indicate multiple occurrences of the previous element. E.g. "SW-COMPONENT-PROTOTYPE R-PORT-PROTOTYPE

destination_type `instance-attribute` ¶

destination_type: Optional[str]

set the destination type of the reference definition

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucInstanceReferenceValue ¶

EcucInstanceReferenceValue(element: Element)

An EcucInstanceReferenceValue provides the mechanism to reference an instance of a prototype

definition `instance-attribute` ¶

definition: Optional[EcucInstanceReferenceDef]

set the parameter definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the parameter definition reference as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

index `instance-attribute` ¶

index: Optional[int]

set the index of the reference

If the reference definition has requiresIndex set to true, then the reference must have an index. Otherwise the index is meaningless.

is_auto_value `instance-attribute` ¶

is_auto_value: Optional[bool]

set the isAutoValue flag

If the reference definition has withAuto set to true, then the reference is allowed to have an auto value.

target `instance-attribute` ¶

target: Optional[Tuple[List[Element], Element]]

Set the target of the reference

An instance reference targets a specific instance of a prototype. In order to uniquely identify the target, the target context is required. The target context is a list of elements that are the parent elements of the target element. The instance reference definition specifies which context elements are required.

EcucIntegerParamDef ¶

EcucIntegerParamDef(element: Element)

EcucIntegerParamDef is used to specify an integer parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[int]

set the default value of the integer parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max `instance-attribute` ¶

max: Optional[int]

set the max value of the integer parameter

min `instance-attribute` ¶

min: Optional[int]

set the min value of the integer parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucLinkerSymbolDef ¶

EcucLinkerSymbolDef(element: Element)

EcucLinkerSymbolDef is used to specify a linker symbol parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[str]

default value of the string parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max_length `instance-attribute` ¶

max_length: Optional[int]

max length of the string parameter

min_length `instance-attribute` ¶

min_length: Optional[int]

min length of the string parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

regular_expression `instance-attribute` ¶

regular_expression: Optional[str]

regular expression for the string parameter

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucModuleConfigurationValues ¶

EcucModuleConfigurationValues(element: Element)

The EcucModuleConfigurationValues is a container for the configuration of a single base software module

definition `instance-attribute` ¶

definition: Optional[EcucModuleDef]

set the module definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the definition reference as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

container_values ¶

container_values() -> Iterator[EcucContainerValue]

create an iterator over the container values in the module configuration

create_container_value ¶

create_container_value(
    name: str, definition: EcucContainerDef
) -> EcucContainerValue

Create a new EcucContainerValue in the module configuration

EcucModuleDef ¶

EcucModuleDef(element: Element)

The EcucModuleDef is a container for the definition of a single base software module

api_service_prefix `instance-attribute` ¶

api_service_prefix: Optional[str]

get or set the apiServicePrefix for the module

for CDD modules the short name of the module is always "CDD", so this attribute is needed to define the prefix for the API services

category `instance-attribute` ¶

category: Optional[EcucModuleDefCategory]

get or set the category of the module definition

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

name `instance-attribute` ¶

name: str

post_build_variant_support `instance-attribute` ¶

post_build_variant_support: Optional[bool]

get or set the post build variant support attribute

refined_module_def `instance-attribute` ¶

refined_module_def: Optional[EcucModuleDef]

get or set the reference to a refined standard module

This reference is only used if the category is VendorSpecificModuleDefinition

supported_config_variants `instance-attribute` ¶

supported_config_variants: List[EcucConfigurationVariant]

set the supported configuration variants for the module

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

containers ¶

containers() -> Iterator[
    Union[EcucChoiceContainerDef, EcucParamConfContainerDef]
]

iterate over all containers in the module

create_choice_container_def ¶

create_choice_container_def(
    name: str,
) -> EcucChoiceContainerDef

create a new EcucChoiceContainerDef in the module

create_param_conf_container_def ¶

create_param_conf_container_def(
    name: str,
) -> EcucParamConfContainerDef

create a new EcucParamConfContainerDef in the module

EcucModuleDefCategory ¶

The EcucModuleDefCategory represents the possible category values for a module definition

StandardizedModuleDefinition `instance-attribute` ¶

StandardizedModuleDefinition: EcucModuleDefCategory

VendorSpecificModuleDefinition `instance-attribute` ¶

VendorSpecificModuleDefinition: EcucModuleDefCategory

EcucMultilineStringParamDef ¶

EcucMultilineStringParamDef(element: Element)

EcucMultilineStringParamDef is used to specify a multiline string parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[str]

default value of the string parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max_length `instance-attribute` ¶

max_length: Optional[int]

max length of the string parameter

min_length `instance-attribute` ¶

min_length: Optional[int]

min length of the string parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

regular_expression `instance-attribute` ¶

regular_expression: Optional[str]

regular expression for the string parameter

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucNumericalParamValue ¶

EcucNumericalParamValue(element: Element)

The EcucNumericalParamValue holds a numerical value and can represent boolean, float or int parameter definitions.

Internally this value is stored as a string; in additon to the value() function, there are also value_bool(), value_int() and value_float() functions, which parse the string and should be used as appropriate.

definition `instance-attribute` ¶

definition: Optional[
    Union[
        EcucBooleanParamDef,
        EcucFloatParamDef,
        EcucIntegerParamDef,
    ]
]

set the parameter definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the parameter definition reference as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

index `instance-attribute` ¶

index: Optional[int]

set the index of the parameter

If the parameter definition has requiresIndex set to true, then the parameter must have an index. Otherwise the index is meaningless.

is_auto_value `instance-attribute` ¶

is_auto_value: Optional[bool]

set the isAutoValue flag

If the parameter definition has withAuto set to true, then the parameter is allowed to have an auto value.

value `instance-attribute` ¶

value: Optional[str]

get or set the numerical value as a string

value_bool `instance-attribute` ¶

value_bool: Optional[bool]

get the numerical value as a boolean

value_float `instance-attribute` ¶

value_float: Optional[float]

get the numerical value as a float

value_int `instance-attribute` ¶

value_int: Optional[int]

get the numerical value as an integer

EcucParamConfContainerDef ¶

EcucParamConfContainerDef(element: Element)

The EcucParamConfContainerDef is used to define configuration containers

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

name `instance-attribute` ¶

name: str

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

create_add_info_param_def ¶

create_add_info_param_def(
    name: str, origin: str
) -> EcucAddInfoParamDef

create a new EcucAddInfoParamDef in the container

create_boolean_param_def ¶

create_boolean_param_def(
    name: str, origin: str
) -> EcucBooleanParamDef

create a new EcucBooleanParamDef in the container

create_choice_container_def ¶

create_choice_container_def(
    name: str,
) -> EcucChoiceContainerDef

create a new EcucChoiceContainerDef as a sub-container

create_choice_reference_def ¶

create_choice_reference_def(
    name: str, origin: str
) -> EcucChoiceReferenceDef

create a new EcucChoiceReferenceDef in the container

create_enumeration_param_def ¶

create_enumeration_param_def(
    name: str, origin: str
) -> EcucEnumerationParamDef

create a new EcucEnumerationParamDef in the container

create_float_param_def ¶

create_float_param_def(
    name: str, origin: str
) -> EcucFloatParamDef

create a new EcucFloatParamDef in the container

create_foreign_reference_def ¶

create_foreign_reference_def(
    name: str, origin: str
) -> EcucForeignReferenceDef

create a new EcucForeignReferenceDef in the container

create_function_name_param_def ¶

create_function_name_param_def(
    name: str, origin: str
) -> EcucFunctionNameDef

create a new EcucFunctionNameDef in the container

create_instance_reference_def ¶

create_instance_reference_def(
    name: str, origin: str
) -> EcucInstanceReferenceDef

create a new EcucInstanceReferenceDef in the container

create_integer_param_def ¶

create_integer_param_def(
    name: str, origin: str
) -> EcucIntegerParamDef

create a new EcucIntegerParamDef in the container

create_linker_symbol_param_def ¶

create_linker_symbol_param_def(
    name: str, origin: str
) -> EcucLinkerSymbolDef

create a new EcucLinkerSymbolDef in the container

create_multiline_string_param_def ¶

create_multiline_string_param_def(
    name: str, origin: str
) -> EcucMultilineStringParamDef

create a new EcucMultilineStringParamDef in the container

create_param_conf_container_def ¶

create_param_conf_container_def(
    name: str,
) -> EcucParamConfContainerDef

create a new EcucParamConfContainerDef as a sub-container

create_reference_def ¶

create_reference_def(
    name: str, origin: str
) -> EcucReferenceDef

create a new EcucReferenceDef in the container

create_string_param_def ¶

create_string_param_def(
    name: str, origin: str
) -> EcucStringParamDef

create a new EcucStringParamDef in the container

create_uri_reference_def ¶

create_uri_reference_def(
    name: str, origin: str
) -> EcucUriReferenceDef

create a new EcucUriReferenceDef in the container

parameters ¶

parameters() -> Iterator[EcucParameterDef]

get the parameters in the container

references ¶

references() -> Iterator[EcucAnyReferenceDef]

get the references in the container

sub_containers ¶

sub_containers() -> Iterator[EcucContainerDef]

iterate over the sub-containers

EcucReferenceDef ¶

EcucReferenceDef(element: Element)

The EcuReferenceDef specifies references between parameters in the ECU configuration.

destination `instance-attribute` ¶

destination: Optional[EcucContainerDef]

destination container of the reference

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucReferenceValue ¶

EcucReferenceValue(element: Element)

An EcucReferenceValue allows the ecu tonfiguration to refer to any identifiable element in the Autosar model

definition `instance-attribute` ¶

definition: Optional[EcucReferenceDef]

set the parameter definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the referenced definition ref as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

index `instance-attribute` ¶

index: Optional[int]

set the index of the reference

If the reference definition has requiresIndex set to true, then the reference must have an index. Otherwise the index is meaningless.

is_auto_value `instance-attribute` ¶

is_auto_value: Optional[bool]

set the isAutoValue flag

If the reference definition has withAuto set to true, then the reference is allowed to have an auto value.

target `instance-attribute` ¶

target: Optional[Element]

Set the target of the reference

EcucStringParamDef ¶

EcucStringParamDef(element: Element)

EcucStringParamDef is used to specify a string parameter in the ECU configuration

default_value `instance-attribute` ¶

default_value: Optional[str]

default value of the string parameter

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

max_length `instance-attribute` ¶

max_length: Optional[int]

max length of the string parameter

min_length `instance-attribute` ¶

min_length: Optional[int]

min length of the string parameter

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

regular_expression `instance-attribute` ¶

regular_expression: Optional[str]

regular expression for the string parameter

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucTextualParamValue ¶

EcucTextualParamValue(element: Element)

The EcucTextualParamValue holds a string value and can represent a enumeration, string, multi-line string, function name or linker symbol parameter definition.

definition `instance-attribute` ¶

definition: Optional[EcucParameterDef]

set the parameter definition reference

definition_ref `instance-attribute` ¶

definition_ref: Optional[str]

get the parameter definition reference as a string

This function is an alternative to definition(); it is useful when the referenced definition is not loaded and can't be resolved.

element `instance-attribute` ¶

element: Element

index `instance-attribute` ¶

index: Optional[int]

set the index of the parameter

If the parameter definition has requiresIndex set to true, then the parameter must have an index. Otherwise the index is meaningless.

is_auto_value `instance-attribute` ¶

is_auto_value: Optional[bool]

set the isAutoValue flag

If the parameter definition has withAuto set to true, then the parameter is allowed to have an auto value.

value `instance-attribute` ¶

value: str

the textual value of the parameter

EcucUriReferenceDef ¶

EcucUriReferenceDef(element: Element)

The EcucUriReferenceDef defines a reference with a destination that is specified via a destinationUri

destination_uri `instance-attribute` ¶

destination_uri: Optional[EcucDestinationUriDef]

set the destination uri of the reference definition

element `instance-attribute` ¶

element: Element

lower_multiplicity `instance-attribute` ¶

lower_multiplicity: Optional[int]

get or set the lower multiplicity attribute

multiplicity_config_classes `instance-attribute` ¶

multiplicity_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the multiplicity config classes of the parameter definition. If an empty list is provided, the multiplicity config classes are removed.

This setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION.

name `instance-attribute` ¶

name: str

origin `instance-attribute` ¶

origin: Optional[str]

set the origin of the parameter definition

The origin is a string that describes if the parameter was defined in the AUTOSAR standard or by a vendor. Standardized parameters use the origin "AUTOSAR_ECUC", while vendors are supposed to use string like 'VendorXyz_v1.3'

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_multiplicity: Optional[bool]

get or set the postBuildVariantMultiplicity attribute

If postBuildVariantMultiplicity is true, then the parameter or reference may have a different number of instances in different post-build variants.

post_build_variant_value `instance-attribute` ¶

post_build_variant_value: Optional[bool]

get or set the postBuildVariantValue attribute

If postBuildVariantValue is true, then the parameter or reference may have different values in different post-build variants.

requires_index `instance-attribute` ¶

requires_index: Optional[bool]

get or set the requiresIndex attribute

upper_multiplicity `instance-attribute` ¶

upper_multiplicity: Optional[int]

get or set the upper multiplicity attribute

upper_multiplicity_infinite `instance-attribute` ¶

upper_multiplicity_infinite: Optional[bool]

get or set the upper multiplicity infinite attribute

if this attribute is set to true, the upper multiplicity is infinite (i.e. the module definition can be used an arbitrary number of times) When this attribute is true, the upper multiplicity attribute may not be used.

value_config_classes `instance-attribute` ¶

value_config_classes: List[
    Tuple[EcucConfigurationClass, EcucConfigurationVariant]
]

set the value config classes of the parameter definition.

If an empty list is provided, the value config classes are removed. According to the specification setting is required if the containing EcucModuleDef has the category VENDOR_SPECIFIC_MODULE_DEFINITION, but in practice it is rarely used.

with_auto `instance-attribute` ¶

with_auto: Optional[bool]

get or set the withAuto attribute

If withAuto is true, then the parameter or reference is allowed to set its isAutoValue attribute to true.

EcucValueCollection ¶

EcucValueCollection(element: Element)

EcucValueCollection collects references to all the separate modules that form the ECU configuration

ecu_extract_reference `instance-attribute` ¶

ecu_extract_reference: Optional[System]

Set the ecu extract reference, which links a System to the ECU configuration

element `instance-attribute` ¶

element: Element

name `instance-attribute` ¶

name: str

add_module_configuration ¶

add_module_configuration(
    module_configuration: EcucModuleConfigurationValues,
) -> None

Add a reference to a module configuration to the collection

module_configurations ¶

module_configurations() -> Iterator[
    EcucModuleConfigurationValues
]

Get the module configurations in the collection

API Documentation: autosar_data.abstraction.ecu_configuration¶

ecu_configuration ¶

EcucAnyReferenceDef module-attribute ¶

EcucContainerDef module-attribute ¶

EcucParameterDef module-attribute ¶

EcucParameterValue module-attribute ¶

EcucAddInfoParamDef ¶

element instance-attribute ¶

lower_multiplicity instance-attribute ¶

multiplicity_config_classes instance-attribute ¶

name instance-attribute ¶

origin instance-attribute ¶

post_build_variant_multiplicity instance-attribute ¶

post_build_variant_value instance-attribute ¶

requires_index instance-attribute ¶

upper_multiplicity instance-attribute ¶

upper_multiplicity_infinite instance-attribute ¶

value_config_classes instance-attribute ¶

with_auto instance-attribute ¶

EcucAddInfoParamValue ¶

element instance-attribute ¶

EcucBooleanParamDef ¶

default_value instance-attribute ¶

element instance-attribute ¶

lower_multiplicity instance-attribute ¶

multiplicity_config_classes instance-attribute ¶

name instance-attribute ¶

origin instance-attribute ¶

post_build_variant_multiplicity instance-attribute ¶

post_build_variant_value instance-attribute ¶

requires_index instance-attribute ¶

upper_multiplicity instance-attribute ¶

upper_multiplicity_infinite instance-attribute ¶

value_config_classes instance-attribute ¶

with_auto instance-attribute ¶

EcucChoiceContainerDef ¶

element instance-attribute ¶

lower_multiplicity instance-attribute ¶

name instance-attribute ¶

upper_multiplicity instance-attribute ¶

upper_multiplicity_infinite instance-attribute ¶

choices ¶

create_param_conf_container_def ¶

EcucChoiceReferenceDef ¶

element instance-attribute ¶

lower_multiplicity instance-attribute ¶

multiplicity_config_classes instance-attribute ¶

name instance-attribute ¶

origin instance-attribute ¶

post_build_variant_multiplicity instance-attribute ¶

post_build_variant_value instance-attribute ¶

requires_index instance-attribute ¶

upper_multiplicity instance-attribute ¶

upper_multiplicity_infinite instance-attribute ¶

value_config_classes instance-attribute ¶

with_auto instance-attribute ¶

add_destination ¶

destination_refs ¶

EcucConfigurationClass ¶

Link instance-attribute ¶

PostBuild instance-attribute ¶

PreCompile instance-attribute ¶

PublishedInformation instance-attribute ¶

EcucConfigurationVariant ¶

PreconfiguredConfiguration instance-attribute ¶

RecommendedConfiguration instance-attribute ¶

VariantLinkTime instance-attribute ¶

VariantPostBuild instance-attribute ¶

VariantPostBuildLoadable instance-attribute ¶

VariantPostBuildSelectable instance-attribute ¶

VariantPreCompile instance-attribute ¶

EcucContainerValue ¶

definition instance-attribute ¶

definition_ref instance-attribute ¶

element instance-attribute ¶

index instance-attribute ¶

name instance-attribute ¶

create_add_info_param_value ¶

create_instance_reference ¶

create_numerical_param_value ¶

EcucAnyReferenceDef `module-attribute` ¶

EcucContainerDef `module-attribute` ¶

EcucParameterDef `module-attribute` ¶

EcucParameterValue `module-attribute` ¶

element `instance-attribute` ¶

lower_multiplicity `instance-attribute` ¶

multiplicity_config_classes `instance-attribute` ¶

name `instance-attribute` ¶

origin `instance-attribute` ¶

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_value `instance-attribute` ¶

requires_index `instance-attribute` ¶

upper_multiplicity `instance-attribute` ¶

upper_multiplicity_infinite `instance-attribute` ¶

value_config_classes `instance-attribute` ¶

with_auto `instance-attribute` ¶

element `instance-attribute` ¶

default_value `instance-attribute` ¶

element `instance-attribute` ¶

lower_multiplicity `instance-attribute` ¶

multiplicity_config_classes `instance-attribute` ¶

name `instance-attribute` ¶

origin `instance-attribute` ¶

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_value `instance-attribute` ¶

requires_index `instance-attribute` ¶

upper_multiplicity `instance-attribute` ¶

upper_multiplicity_infinite `instance-attribute` ¶

value_config_classes `instance-attribute` ¶

with_auto `instance-attribute` ¶

element `instance-attribute` ¶

lower_multiplicity `instance-attribute` ¶

name `instance-attribute` ¶

upper_multiplicity `instance-attribute` ¶

upper_multiplicity_infinite `instance-attribute` ¶

element `instance-attribute` ¶

lower_multiplicity `instance-attribute` ¶

multiplicity_config_classes `instance-attribute` ¶

name `instance-attribute` ¶

origin `instance-attribute` ¶

post_build_variant_multiplicity `instance-attribute` ¶

post_build_variant_value `instance-attribute` ¶

requires_index `instance-attribute` ¶

upper_multiplicity `instance-attribute` ¶

upper_multiplicity_infinite `instance-attribute` ¶

value_config_classes `instance-attribute` ¶

with_auto `instance-attribute` ¶

Link `instance-attribute` ¶

PostBuild `instance-attribute` ¶

PreCompile `instance-attribute` ¶

PublishedInformation `instance-attribute` ¶

PreconfiguredConfiguration `instance-attribute` ¶

RecommendedConfiguration `instance-attribute` ¶

VariantLinkTime `instance-attribute` ¶

VariantPostBuild `instance-attribute` ¶

VariantPostBuildLoadable `instance-attribute` ¶

VariantPostBuildSelectable `instance-attribute` ¶

VariantPreCompile `instance-attribute` ¶

definition `instance-attribute` ¶

definition_ref `instance-attribute` ¶

element `instance-attribute` ¶

index `instance-attribute` ¶

name `instance-attribute` ¶

element `instance-attribute` ¶

name `instance-attribute` ¶

element `instance-attribute` ¶

name `instance-attribute` ¶

nesting_contract `instance-attribute` ¶

element `instance-attribute` ¶

name `instance-attribute` ¶

LeafOfTargetContainer `instance-attribute` ¶

TargetContainer `instance-attribute` ¶

VertexOfTargetContainer `instance-attribute` ¶

element `instance-attribute` ¶

name `instance-attribute` ¶

default_value `instance-attribute` ¶

element `instance-attribute` ¶

lower_multiplicity `instance-attribute` ¶

multiplicity_config_classes `instance-attribute` ¶

name `instance-attribute` ¶