AUTOSAR Element Properties

Properties of AUTOSAR elements

AUTOSAR elements can belong to several different categories that each have their own configurable properties. These properties are organized below by element category.

After creating a Simulink^® model representation of an AUTOSAR software component, you refine the AUTOSAR configuration. You can refine the AUTOSAR configuration graphically, using the AUTOSAR Dictionary and the Code Mappings editor, or programmatically, using the autosar.api.getAUTOSARProperties and autosar.api.getSimulinkMapping object functions.

To configure these properties using the AUTOSAR Dictionary, see Configure AUTOSAR Elements and Properties.

Sender-Receiver Interfaces

DataElements — Data elements of sender-receiver interface

cell array of character vectors

Data elements of the associated interface, specified as a cell array.

Example: {'Interface1/DE1'} {'Interface1/DE2'}

Data elements have these properties:

DisplayFormat — Display format

character vector | string scalar

Display format of inter-runnable variables, sender-receiver interface data elements, client-server interface operation arguments, and CompuMethods, specified as a character vector or string scalar in the form %[flags][width][.precision][type].

For more information, see Configure DisplayFormat.

Example: "%4.3f"

Example: "%+6.2f"

Example: "%2.1d"

LongName — Element description

character vector | string scalar

Description of an element in a sender-receiver interface, specified as a character vector or string scalar.

Example: 'Data element DE1, ReadOnly, FlowData'

Kind — Kind of sender-receiver interface data element

"Other" (default) | "Const" | "Shared" | "Pim"

Kind of sender-receiver interface data element, specified as "Other", "Const", "Shared", or "Pim".

Example: "Other"

Name — Name of data element

character vector | string scalar

Name of data element, specified as a character vector or string scalar.

Example: "myElement"

SwAddrMethod — Software address methods of data element

character vector | string scalar

Paths of software address methods of the data element, specified as a character vector or string scalar. For more information, see Configure SwAddrMethod.

Example: '/Company/Powertrain/DataTypes/SwAddrMethods/VAR'

SwAlignment — Software alignment

"8" | "12" | "32" | "UNSPECIFIED" | "BOOLEAN"

Software alignment, specified as: "8", "12", "32", "UNSPECIFIED", or "BOOLEAN".

For more information, see Configure SwAlignment.

Example: "32"

SwCalibrationAccess — Software calibration access of arguments

"ReadOnly" (default) | "ReadWrite" | "NotAccessible"

Software calibration access of measurement variables, calibration parameters, and signal and parameter data objects, specified as "ReadOnly", "ReadWrite", or "NotAccessible". For more information, see Configure SwCalibrationAccess.

Example: "ReadWrite"

Type — Short name of data type

character vector | string scalar

Qualified or short name of an implementation or application data type, specified as a string scalar or character vector.

Example: "Boolean"

IsService — Option to set interface as service

false or 0 (default) | true or 1

Option to set the interface as a service interface, specified as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

ModeGroup — Mode groups of interface

cell array of character vectors

Mode groups of the associated interface, specified as a cell array of character vectors.

Example: {'SR1/edgmodes'}

Name — Name of sender-receiver interface

character vector | string scalar

Name of sender-receiver interface, specified as a character vector or string scalar.

Example: "MySRInterface"

Client-Server Interfaces

IsService — Option to set interface as service

false or 0 (default) | true or 1

Option to set the interface as a service interface, as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

Name — Name of interface

character vector | string scalar

Name of client-server interface, specified as a string scalar or character vector.

Example: "MyCSInterface"

Operations — Operations of interface

cell array of character vectors

Lists the client-server operations of the interface, specified as a cell array of character vectors.

Example: {'CS1/Operation1'} {'CS1/Operation2'}

Operations have these properties:

Arguments — Arguments of operation

cell array of character vectors

Arguments of the operation, specified as a cell array of character vectors.

Example: {'CS1/Operation1/Argument1' 'CS1/Operation1/Argument2'}

Arguments have these properties:

Direction — Direction of operation argument

"In" (default) | "Out" | "InOut" | "Error"

The direction of the operation argument, specified as "In", "Out", "InOut", or "Error". For more information, see Client-Server Interfaces.

Example: "Out"

DisplayFormat — Display format

character vector | string scalar

Display format of inter-runnable variables, sender-receiver interface data elements, client-server interface operation arguments, and CompuMethods, specified as a character vector or string scalar in the form %[flags][width][.precision][type].

For more information, see Configure DisplayFormat.

Example: "%4.3f"

Example: "%+6.2f"

Example: "%2.1d"

Name — Name of argument

character vector | string scalar

Name of argument of the associated operation, specified as a character vector or string scalar.

Example: "myArgument"

SwAddrMethod — Software address methods of argument

character vector | string scalar

Paths of software address methods associated with the argument, specified as a character vector or string scalar. For more information, see Configure SwAddrMethod.

Example: '/Company/Powertrain/DataTypes/SwAddrMethods/VAR'

SwAlignment — Software alignment

"8" | "12" | "32" | "UNSPECIFIED" | "BOOLEAN"

Software alignment, specified as: "8", "12", "32", "UNSPECIFIED", or "BOOLEAN".

For more information, see Configure SwAlignment.

Example: "32"

SwCalibrationAccess — Software calibration access of arguments

"ReadOnly" (default) | "ReadWrite" | "NotAccessible"

Software calibration access of measurement variables, calibration parameters, and signal and parameter data objects, specified as "ReadOnly", "ReadWrite", or "NotAccessible". For more information, see Configure SwCalibrationAccess.

Example: "ReadWrite"

Type — Short name of data type

character vector | string scalar

Qualified or short name of an implementation or application data type, specified as a string scalar or character vector.

Example: "Double"

Name — Name of operation

character vector | string scalar

Name of client-server operation, specified as a string scalar or character vector.

Example: "MyCSOp"

PossibleError — User-defined error

character vector | string scalar

User defined error of category ApplicationError.

PossibleError has these properties:

Name — Name of error

character vector | string scalar

Name of the possible error, specified as a character vector or string scalar.

Example: "myError"

errorCode — Integer-valued error code

character vector | string scalar

Returned value when the error condition is met, specified as a character vector or string scalar. The integer value must be in the range of -231 to 231 - 1.

Example: '1'

Dependencies

This parameter is available only when error status ports, such as a Function Caller blocks, are present at the corresponding server call-point location.

Mode-Switch Interfaces

IsService — Option to set interface as service

true or 1 (default) | false or 0

Option to set the interface as a service interface, specified as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

ModeGroup — Mode group of interface

character vector | string scalar

Mode group of the associated interface, specified as a character vector or string scalar.

Example: '/pkg/if/Interface3/mgEcuMode'

Name — Name of mode-switch interface

character vector | string scalar

Name of mode-switch interface, specified as a character vector or string scalar.

Example: "MyMSInterface"

Nonvolatile Interfaces

DataElements — Data elements of nonvolatile interface

cell array of character vectors

Lists the data elements of the nonvolatile interface, specified as a cell array of character vectors.

Example: {'NV/NvData1'} {'NV/NvData2'}

Data elements have these properties:

DisplayFormat — Display format

character vector | string scalar

Display format of inter-runnable variables, sender-receiver interface data elements, client-server interface operation arguments, and CompuMethods, specified as a character vector or string scalar in the form %[flags][width][.precision][type].

For more information, see Configure DisplayFormat.

Example: "%4.3f"

Example: "%+6.2f"

Example: "%2.1d"

Kind — Kind of nonvolatile interface data element

"Other" (default) | "Const" | "Shared" | "Pim"

Kind of nonvolatile interface data element, specified as "Other", "Const", "Shared", or "Pim".

Example: "Other"

Name — Name of data element

character vector | string scalar

Name of data element, specified as a character vector or string scalar.

Example: "myElement"

SwAddrMethod — Software address methods of data element

character vector | string scalar

Paths of software address methods of the data element, specified as a character vector or string scalar. For more information, see Configure SwAddrMethod.

Example: '/Company/Powertrain/DataTypes/SwAddrMethods/VAR'

SwAlignment — Software alignment

"8" | "12" | "32" | "UNSPECIFIED" | "BOOLEAN"

Software alignment, specified as: "8", "12", "32", "UNSPECIFIED", or "BOOLEAN".

For more information, see Configure SwAlignment.

Example: "32"

SwCalibrationAccess — Software calibration access of arguments

"ReadOnly" (default) | "ReadWrite" | "NotAccessible"

Software calibration access of measurement variables, calibration parameters, and signal and parameter data objects, specified as "ReadOnly", "ReadWrite", or "NotAccessible". For more information, see Configure SwCalibrationAccess.

Example: "ReadWrite"

Type — Short name of data type

character vector | string scalar

Qualified or short name of an implementation or application data type, specified as a string scalar or character vector.

Example: "Boolean"

IsService — Option to set interface as service

false or 0 (default) | true or 1

Option to set the interface as a service interface, specified as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

Name — Name of nonvolatile interface

character vector | string scalar

Name of nonvolatile interface, specified as a character vector or string scalar.

Example: "MyNVInterface"

Parameter Interfaces

DataElements — Data elements of parameter interface

cell array of character vectors

Data elements of the parameter interface, specified as a cell array of character vectors.

Example: {'ParamIf/DataElement1'} {'ParamIf/DataElement2'}

DisplayFormat — Display format

character vector | string scalar

Display format of inter-runnable variables, sender-receiver interface data elements, client-server interface operation arguments, and CompuMethods, specified as a character vector or string scalar in the form %[flags][width][.precision][type].

For more information, see Configure DisplayFormat.

Example: "%4.3f"

Example: "%+6.2f"

Example: "%2.1d"

LongName — Element description

character vector | string scalar

Description of an element in a sender-receiver interface, specified as a character vector or string scalar.

Example: 'Data element DE1, ReadOnly, FlowData'

Kind — Kind of parameter interface data element

"Other" (default) | "Const" | "Shared" | "Pim"

Kind of parameter interface data element, specified as "Other", "Const", "Shared", or "Pim".

Example: "Other"

Name — Name of data element

character vector | string scalar

Name of data element, specified as a character vector or string scalar.

Example: "myElement"

SwAddrMethod — Software address methods of data element

character vector | string scalar

Paths of software address methods of the data element, specified as a character vector or string scalar. For more information, see Configure SwAddrMethod.

Example: '/Company/Powertrain/DataTypes/SwAddrMethods/VAR'

SwAlignment — Software alignment

"8" | "12" | "32" | "UNSPECIFIED" | "BOOLEAN"

Software alignment, specified as: "8", "12", "32", "UNSPECIFIED", or "BOOLEAN".

For more information, see Configure SwAlignment.

Example: "32"

SwCalibrationAccess — Software calibration access of arguments

"ReadOnly" (default) | "ReadWrite" | "NotAccessible"

Software calibration access of measurement variables, calibration parameters, and signal and parameter data objects, specified as "ReadOnly", "ReadWrite", or "NotAccessible". For more information, see Configure SwCalibrationAccess.

Example: "ReadWrite"

Type — Short name of data type

character vector | string scalar

Qualified or short name of an implementation or application data type, specified as a string scalar or character vector.

Example: "Boolean"

IsService — Option to set interface as service

false or 0 (default) | true or 1

Option to set the interface as a service interface, specified as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

Name — Name of parameter interface

character vector | string scalar

Name of parameter interface, specified as a character vector or string scalar.

Example: "MyParamInterface"

Trigger Interfaces

Name — Name of trigger interface

character vector | string scalar

Name of trigger interface, specified as a character vector or string scalar.

Example: "MyTriggerInterface"

IsService — Option to set interface as service

false or 0 (default) | true or 1

Option to set interface as service, specified as a numeric or logical 0 (false) or 1 (true). This property impacts the location of interfaces in the generated code. View the Exported XML File field in the AUTOSAR dictionary for the location in the generated ARXML.

Example: false

Example: 1

Triggers — Triggers of interface

cell array of character vectors

Triggers of the trigger interface, specified as a cell array of character vectors.

Example: {'TriggerIf/Trigger1'}

CseCode — Time unit base of trigger period

"None" (default) | "CSE0" | "CSE1" | "CSE2" | "CSE3" | "CSE4" | "CSE5" | ...

Value representing the time unit base used to define the trigger period in combination with a CseCodeFactor value.

For example, if you'd like a trigger period of 20 seconds you could either:

• Set CSECode to CSE6 (which provides a time unit base of 1 second) and CseCodeFactor to 20

• Set CSECode to CSE4 (which provides a time unit base of 10 seconds) and CseCodeFactor to 2.

CseCode	Time Base
None	Unspecified (trigger is not periodic)
CSE0	1 µsec (microsecond)
CSE1	10 µsec
CSE2	100 µsec
CSE3	1 msec (millisecond)
CSE4	10 msec
CSE5	100 msec
CSE6	1 second
CSE7	10 seconds
CSE8	1 minute
CSE9	1 hour
CSE10	1 day
CSE20	1 fs (femtosecond)
CSE21	10 fs
CSE22	100 fs
CSE23	1 ps (picosecond)
CSE24	10 ps
CSE25	100 ps
CSE26	1 ns (nanosecond)
CSE27	10 ns
CSE28	100 ns
CSE100	Angular degrees
CSE101	Revolutions (1 = 360 degrees)
CSE102	Cycle (1 = 720 degrees)
CSE997	Computing cycle
CSE998	When frame available
CSE999	Always when there is a new value
CSE1000	Nondeterministic (no fixed scaling)

For more information, see Trigger Interfaces and property CseCodeFactor.

Example: "CSE100"

CseCodeFactor — Scaling factor for trigger period

integer

The scaling factor for the time value based on the specified CseCode, specified as any numeric value.

For example, if you'd like a trigger period of 20 seconds you could either:

• Set CseCode to CSE6 (which provides a time unit base of 1 second) and CseCodeFactor to 20

• Set CseCode to CSE4 (which provides a time unit base of 10 seconds) and CseCodeFactor to 2.

For more information, see Trigger Interfaces and property CseCode.

Example: 1

Name — Name of trigger

character vector | string scalar

Name of trigger, specified as a character vector or string scalar.

Example: "myTrigger"

Version History

Introduced in R2019a