ASAM ODS Base Element Definitions

Table of Contents

Only one application element in an ASAM ODS database may be derived from the base element AoEnvironment. Additionally, the environment application element can be instantiated only once. The attribute of base attribute type "NAME" of this base element contains the global name of the ASAM ODS data source. It is used to identify the data source in ATF files, as a global name in the ASAM path and as the service name for CORBA Name Services. The name should be chosen in a way that it is as unique as possible to avoid naming collisions with other services.

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoPhysicalDimension	S[0:?]	physicaldimension	environment
	AoQuantity	S[0:?]	quantity	environment
	AoQuantityGroup	S[0:?]	quantitygroup	environment
	AoTest	S[0:?]	tests	environment
	AoTestEquipment	S[0:?]	equipments	environment
	AoTestSequence	S[0:?]	testsequence	environment
	AoUnit	S[0:?]	unit	environment
	AoUnitGroup	S[0:?]	unitgroup	environment
	AoUnitUnderTest	S[0:?]	uuts	environment
	AoUser	S[0:?]	user	environment
	AoUserGroup	S[0:?]	usergroup	environment
	AoAny	S[0:?]	any	environment

1. In the whole model only one entity of type AoTest (or a derived subtype) may be instantiated. This one is the main test (e.g. an application element called "Testseries").

2. In the whole model only one entity of type AoMeasurement (or a derived subtype) may be instantiated (e.g. called "Measurement").

3. Hierarchy creation rules
1. Assuming no entities of type AoSubTest (or its subtype) are used, then the attribute "children" of the AoTest element "Testseries" is always of the type "Measurement", i.e. children of an instance of "Testseries" are all instances of "Measurement". It is not allowed to have children of type "Testseries". The Test-Measurement-Hierachy then has the form: Testseries --o Measurement
2. Assuming there is one application element derived from AoSubTest (e.g. called "Maintest"), the attribute "children" of "Testseries" is of type "Maintest", and the attribute "parent_test" of "Maintest" is of type "Testseries". The attribute "children" of "Maintest" is of type "Measurement". The Test-Measurement-Hierarchie then has the form: Testseries --o Maintest --o Measurement
3. Assuming more than one application element have been derived from AoSubTest (e.g. "Maintest", "Subtest" and "Subsubtest"), then they have to be build strictly as a chain: Testseries --o Maintest --o Subtest --o Subsubtest --o Measurement

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	children	test
	AoSubTest	S[0:?]	children	parent_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	children	test
	AoSubTest	S[0:?]	children	parent_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTest	S[1:1]	parent_test	children
	AoSubTest	S[1:1]	parent_test	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurementQuantity	S[0:?]	measurement_quantities	measurement
	AoSubmatrix	S[0:?]	submatrices	measurement

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTest	S[1:1]	test	children
	AoSubTest	S[1:1]	test	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestEquipment	S[0:?]	equipments	measurement
	AoTestEquipmentPart	S[0:?]	equipments	measurement
	AoTestDevice	S[0:?]	equipments	measurement
	AoTestSequence	S[0:?]	sequences	measurement
	AoTestSequencePart	S[0:?]	sequences	measurement
	AoUnitUnderTest	S[0:?]	units_under_test	measurement
	AoUnitUnderTestPart	S[0:?]	units_under_test	measurement

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[1:1]	measurement	measurement_quantities

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoLocalColumn	S[0:?]	local_columns	measurement_quantity
	AoMeasurementQuantity	Optional L[1:?]	is_scaled_by	-
	AoQuantity	S[1:1]	quantity	-
	AoTestEquipment	Optional S[1:1]	channel	-
	AoTestEquipmentPart	Optional S[1:1]	channel	-
	AoTestDevice	Optional S[1:1]	channel	-
	AoUnit	S[1:1]	unit	-

The link instructions for producing of the measurement matrix could be:

  + Merge according to defined "measurement quantities"
  + Join according to defined "measurement quantities"
  + Sort
  (+ Compress, i.e. removing of duplicates with tolerance; 
     within ASAM ODS two rows are not combined into one).

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoLocalColumn	L[0:?]	local_columns	submatrices

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[1:1]	measurement	submatrices

The attribute "values" holds a sequence of values. The datatype is identical for all values in a sequence. Each value in the sequence may contain either exactly one scalar measurement value or an n-dimensional array.

The datatype of the values is defined in the related measurement quantity in attribute "datatype". The name of the relation from the local column to the measurement quantity is "measurement_quantity".

The number of values in the sequence is defined in the parent submatrix of the local column. The name of the relation from the local column to the submatrix is "submatrix". The name of the attribute in submatrix containing the number of values in a local column is "number_of_rows".

For multi-dimensional data the number of dimensions is defined in the attribute "rank" of the related measurement quantity. the name of the relation to the measurement quantity is "measurement_quantity" (same as for the datatype above). The dimensions of the multi-dimensional array are defined also in the related measurement quantity in attribute "dimension".

The total number of values in the n-dimensional array may be calculated as follows:

     n_values = number_of_rows;
     FOR i=1...rank                             [nothing happens if rank=0]
         n_values = n_values * dimension[i-1];
     END_FOR;

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoExternalComponent	S[0:1]	external_component	local_column

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoSubmatrix	S[1:1]	submatrix	local_columns

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurementQuantity	S[1:1]	measurement_quantity	local_columns

Please note that several physical dimensions may exist that have the same set of exponents

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	physicaldimension

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUnit	S[0:?]	units	phys_dimension

A quantity is not a measurement channel, it rather describes a physical phenomenon. Examples:
- torque (Real)
- time (Real)
- estimated temperature {"cold","warm","hot"}
- ignition on (Boolean)
- ignition characteristic curve (which is applicable for a work point) (matrix of Real values).

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoQuantity	S[0:?]	successors	predecessor

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	quantities
	AoQuantity	S[0:1]	predecessor	successors

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurementQuantity	S[0:?]	quantity	-
	AoQuantityGroup	S[?:?]	groups	quantities
	AoUnit	S[0:1]	default_unit	-

Example for a group assignment of a quantity: The quantity "F.FL" belongs, as indicated in its hierarchical name structure, to the forces ("F") and to a position "front left" ("FL"). It may belong to the quantity groups: "length force", "calculated quantity", "filtered quantity" and "front left phenomena".

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	quantitygroup

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoQuantity	S[?:?]	quantities	groups

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestEquipmentPart	S[0:?]	children	parent_equipment
	AoTestDevice	S[0:?]	children	parent_equipment

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	testequipment

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	equipments
	AoMeasurementQuantity	Optional S[0:?]	measurement_quantity	channel

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestEquipmentPart	S[0:?]	children	parent_equipment
	AoTestDevice	S[0:?]	children	parent_equipment

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestEquipment	S[1:1]	parent_equipment	children
	AoTestEquipmentPart	S[1:1]	parent_equipment	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	equipments
	AoMeasurementQuantity	Optional S[0:?]	measurement_quantity	channel

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestDevice	S[0:?]	children	parent_equipment

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestEquipment	S[1:1]	parent_equipment	children
	AoTestEquipmentPart	S[1:1]	parent_equipment	children
	AoTestDevice	S[1:1]	parent_equipment	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	equipments
	AoMeasurementQuantity	Optional S[0:?]	measurement_quantity	channel

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestSequencePart	S[0:?]	children	parent_sequence

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	testsequence

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	sequences

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestSequencePart	S[0:?]	children	parent_sequence

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoTestSequence	S[1:1]	parent_sequence	children
	AoTestSequencePart	S[1:1]	parent_sequence	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	sequences

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUnitUnderTestPart	S[0:?]	children	parent_unit_under_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	unitundertest

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	units_under_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUnitUnderTestPart	S[0:?]	children	parent_unit_under_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUnitUnderTest	S[1:1]	parent_unit_under_test	children
	AoUnitUnderTestPart	S[1:1]	parent_unit_under_test	children

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurement	S[0:?]	measurement	units_under_test

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	units

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoMeasurementQuantity	S[0:?]	unit	-
	AoPhysicalDimension	S[1:1]	phys_dimension	units
	AoQuantity	S[0:?]	default_unit	-
	AoUnitGroup	S[?:?]	groups	units

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	unitgroup

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUnit	S[?:?]	units	groups

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	user

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUserGroup	S[?:?]	groups	users

1. A User may belong to one or more than one "User Group".
2. A User's right to access data objects is defined by his/her membership to User Groups.
3. User Group is an abstract term, which, from its concept, does not refer to particular organizational units.
4. This concept does not provide any further structuring of User Groups (i.e. no sub-groups).

The Superuser group is identified by a Superuser flag in the AoUserGroup application element. Exactly one user group may have this flag. This must be configured (outside ODS) at system setup, and it is not accessible via the ODS interface. At least one user must be allocated to this user group. This must be configured (outside ODS) at system setup. The server does not allow the removal of the last existing user in this group.

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	usergroup

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoUser	S[?:?]	users	groups

Attribute	Description	Name of base attribute
Identifier	Filename (URL)	filename_url
Type specification	Data type and byte order	type_specification	KS: No definition
Length specification	Number of values	length	KS: No definition
IniOffset	Start offset	start_offset
BlockSize	Size of a row of the block, also definong the offset for the next value (if local column holds only one value)	blocksize
ValOffsets	Offset from begin of block to respective value	value_offsets
ValPerBlock	Number of values/block	valuesperblock
FlagIdentifier	Filename of the flags (URL)	flags_filename_url
IniOffsetFlags	Start offset of the flags	flags_start_offset

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoLocalColumn	S[1:1]	local_column	external_component

AoAny is however a good solution to allow access to very specific data. It is also often used to test the behavior of new ASAM ODS base elements.

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoAny	S[0:?]	child	father

Icon	Base Element Name	Cardinality	Reference Name	Inverse Reference Name
	AoEnvironment	S[1:1]	environment	any
	AoAny	S[0:1]	father	child