ASAM ODS Base Model
asam31
|
Latest modification: $Date: 2014/07/10 10:15:22 $ |
ASAM ODS 5.3.0 Base Element Definitions
Table of Elements
Table of Enumerations
AoEnvironment (ID=1, HighQSoft: 101) Next Top
This is the definition of the environment base element. The base element AoEnvironment may be used
as the parent of all other top level base elements. If these father/child relations are not explicitly
available in the underlying data, they are assumed by an ASAM ODS application. The reason is that large
numbers of instances lead to a lot of references to the environment instance (redundant information).
Some older servers still keep this redundant information even if it is no longer neccessary.
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.
AoEnvironment Base Attributes
Attribute Name | Datatype | Key | Mandatory | Optional | Unique | meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the ASAM ODS server |
description | DT_STRING | no | no | yes | no | Describing text for the ASAM ODS server (optional) |
version | DT_STRING | no | no | yes | no | Version of the ASAM ODS server (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). Should not be used here because inheritance is not useful for application elements of type AoEnvironment |
meaning_of_aliases | DS_STRING | no | no | yes | no | The meaning of alias names in the entity map |
max_test_level | DT_LONG | no | no | yes | no | The number of application elements of the type AoTest and AoSubTest |
base_model_version | DT_STRING | no | no | yes | no | Schema name (e.g. 'asam31') |
application_model_type | DT_STRING | no | no | yes | no | May contain many names, comma-separated, like CALIBRATION, NVH, SECURITY etc. |
application_model_version | DT_STRING | no | no | yes | no | Any operator-supplied name |
timezone | DT_STRING | no | no | yes | no | Examples: "GMT-07:00", "GMT+05:45" Timezones are additional information, they do not change time values. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoEnvironment Base References
AoEnvironment is (optional) father of:
AoEnvironment has no father.
AoEnvironment informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoNameMap |
S[0:?] | entity_mapping | environment |
AoTest (ID=36, HighQSoft: 102) Next Previous Top
The base element AoTest is used to build hierarchical structures (together with AoSubTest). The
functionality of AoTest within ASAM ODS is similar to the root directory in a hierarchical file
system. AoSubTest is comparable to subdirectories. AoTest and AoSubtest are the hierarchy building
blocks for test and measurement data and the base element AoMeasurement has the role of representing
the leaves of the tree. For the management of measurements and tests the following rules must be followed:
- 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").
- In the whole model only one entity of type AoMeasurement (or a derived subtype) may be
instantiated (e.g. called "Measurement").
-
Hierarchy creation rules
- 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-Hierarchy
then has the form: Testseries --o Measurement
- 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-Hierarchy then has the form:
Testseries --o Maintest --o Measurement
- Assuming more than one application element has been derived from AoSubTest (e.g. "Maintest",
"Subtest" and "Subsubtest"), then they have to be built strictly as a chain: Testseries --o
Maintest --o Subtest --o Subsubtest --o Measurement
In this chain the uppermost application element of AoSubTest (here "Maintest") has a "parent_test"
attribute of type "Testseries" (the AoTest element), and the lowermost application element of AoSubTest
(here "Subsubtest") has a "children" attribute of type "Measurement". The other "parent_test" and
"children" attributes of the inner AoSubTest application elements always have exactly the type of
the corresponding application elements in the chain (e.g. the "parent_test" attribute of "Subtest"
is of type "Maintest", and the "children" attribute of "Subtest" is of type "Subsubtest"). So the
rule says: It is not allowed to have a "parent_test" relation to an instance of another application
element than the one defined in the chain as the parent test. A similar rule is valid for the
"children" attribute.
AoTest Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTest Base References
AoTest is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
Mandatory S[0:?] | children | test |
 |
AoSubTest |
Mandatory S[0:?] | children | parent_test |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTest is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoEnvironment |
Mandatory S[0:1] | environment | tests |
AoTest has no informational relations.
AoSubTest (ID=2, HighQSoft: 106) Next Previous Top
The base element AoSubTest is used to build hierarchical structures (together with AoTest). The
functionality of AoTest within ASAM ODS is similar to the root directory in a hierarchical file
system. AoSubTest is comparable to subdirectories. AoTest and AoSubtest are the hierarchy building
blocks for test and measurement data and the base element AoMeasurement has the role of representing
the leaves of the tree. For hierarchy building rules see the description of AoTest.
AoSubTest Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoSubTest Base References
AoSubTest is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
Mandatory S[0:?] | children | test |
 |
AoSubTest |
Mandatory S[0:?] | children | parent_test |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoSubTest is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTest |
Mandatory S[1:1] | parent_test | children |
 |
AoSubTest |
Mandatory S[1:1] | parent_test | children |
AoSubTest has no informational relations.
AoMeasurement (ID=3, HighQSoft: 103) Next Previous Top
The base element AoMeasurement represents the measurement matrix. AoMeasurement is the linking point for all data that relate to one test run.
The "measurement" refers to an unchanged set of unit under test individuals on a test stand, that means to a constant 'test
equipment'. The "measurement" possesses "measurement quantities", which in turn possess
"values" in specified "measured points". The "measurement" is an abstract term that puts
together the "quantities" and their "values" according to the application. The "measurement"
may also serve as a "pattern measurement" for a description of reference values of a "test
step". The quantities referred in the "pattern measurement" are used as set quantities in the
"measurement". The descriptive data that refers to a special "measurement", as
the date of the measurement, the name of the test stand leader are attributes of
"measurement" ("application attributes").
AoMeasurement Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
measurement_begin | DT_DATE | no | no | yes | no | Time stamp at measurement begin |
measurement_end | DT_DATE | no | no | yes | no | Time stamp at measurement end |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
ao_values_accessed | DT_DATE | no | no | yes | no | The date/time of the last access to the values of the measurement. (The attribute value is autogenerated by the server) |
ao_values_accessed_by | DT_STRING | no | no | yes | no | The user of the last access to the values of the measurement. (The attribute value is autogenerated by the server) |
ao_values_modified | DT_DATE | no | no | yes | no | The date/time of the last modification of the values of the measurement. (The attribute value is autogenerated by the server) |
ao_values_modified_by | DT_STRING | no | no | yes | no | The user of the last modification to the values of the measurement. (The attribute value is autogenerated by the server) |
ao_storagetype | DT_ENUM (ao_storagetype_enum) | no | no | yes | no | The user of the last modification to the values of the measurement. (The attribute value is autogenerated by the server) |
ao_mea_size | DT_LONGLONG | no | no | yes | no | The approximate size of the measurement values. (The attribute value is autogenerated by the server) |
AoMeasurement Base References
AoMeasurement is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurementQuantity |
Mandatory S[0:?] | measurement_quantities | measurement |
 |
AoSubmatrix |
Mandatory S[0:?] | submatrices | measurement |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoMeasurement is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTest |
Mandatory S[1:1] | test | children |
 |
AoSubTest |
Mandatory S[1:1] | test | children |
AoMeasurement informational relations:
AoMeasurementQuantity (ID=4, HighQSoft: 105) Next Previous Top
The base element AoMeasurementQuantity represents a column of the measurement value matrix.
It expresses the use of a "quantity" during "measurement". The specified "measurement quantity"
occurs only once in one "measurement". The "measurement quantities" may stand in mutual relationship;
it means that one quantity is dependent from the other. Particularly for time flow measurements there
is the relation of one quantity to the corresponding time quantity.
A "measurement quantity" further describes a column of the value matrix. It expresses the
use of a "quantity" during "measurement". The specified "measurement quantity" appears
only once in one "measurement". The "measurement quantities" may be related to each
other, i.e. one quantity may be depending on another one. Particularly for time flow
measurements this relation is used between a measurement quantity and the corresponding
time quantity.
AoMeasurementQuantity Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
datatype | DT_ENUM (datatype_enum) | no | yes | no | no | Format in which the data is stored |
rank | DT_LONG | no | no | yes | no | Rank of a tensor, number of value dimensions |
dimension | DS_LONG | no | no | yes | no | Number of values for each rank |
type_size | DT_LONG | no | no | yes | no | Length limit of a value, for example the maximum length of a string |
interpolation | DT_ENUM (interpolation_enum) | no | no | yes | no | Which is used when needed, during interpolation |
minimum | DT_DOUBLE | no | no | yes | no | Minimum value (optional) |
maximum | DT_DOUBLE | no | no | yes | no | Maximum value (optional) |
average | DT_DOUBLE | no | no | yes | no | Average (optional) |
standard_deviation | DT_DOUBLE | no | no | yes | no | Standard deviation (optional) |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoMeasurementQuantity Base References
AoMeasurementQuantity can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoMeasurementQuantity is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
Mandatory S[1:1] | measurement | measurement_quantities |
AoMeasurementQuantity informational relations:
AoSubmatrix (ID=38, HighQSoft: 104) Next Previous Top
Submatrices are generally homogeneous subareas of a measurement matrix. The inhomogeneous
measurement matrix of the "measurement" has to be created out of the corresponding
"submatrices" using the specified "link instructions" stored in the "measurement".
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).
Submatrices are the objects that are physically stored.
AoSubmatrix Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
number_of_rows | DT_LONG | no | yes | no | no | Number of „measured points“ in this submatrix |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoSubmatrix Base References
AoSubmatrix is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoLocalColumn |
Mandatory S[0:?] | local_columns | submatrix |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoSubmatrix is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
Mandatory S[1:1] | measurement | submatrices |
AoSubmatrix has no informational relations.
AoLocalColumn (ID=39, HighQSoft: 107) Next Previous Top
The base element AoLocalColumn represents the columns of 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 the 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;
Do not use this algorithm if the attribute "sequence_representation" is set to
"explicit" or "formula".
AoLocalColumn Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
global_flag | DT_SHORT | no | no | yes | no | A 2-byte integer whose bits have specific meanings |
flags | DS_SHORT | no | no | yes | no | Optional List of 2-byte integers with bitwise meaning, the length must be the same as the length of “values” and must coincide with the attribute “number_of_rows” in the submatrix. |
independent | DT_SHORT | no | yes | no | no | 1 – independent 0 – dependent only one local_column per submatrix may be independent |
minimum | DT_DOUBLE | no | no | yes | no | Minimum (optional) |
maximum | DT_DOUBLE | no | no | yes | no | Maximum (optional) |
sequence_representation | DT_ENUM (seq_rep_enum) | no | yes | no | no | Enumeration which defined the representation of the values. |
raw_datatype | DT_ENUM (datatype_enum) | no | no | yes | no | the optional datatype enumeration value that describes the datatype of the raw data; must be one of the enumeration items of datatype_enum. This attribute is required in the instance when the sequence_representation is one of (raw_linear, raw_polynominal, raw_linear_calibrated, raw_linear_external, raw_polynominal_external, raw_linear_calibrated_external). |
generation_parameters | DS_DOUBLE | no | no | yes | no | List of parameters necessary to calculate the values for implicit and raw local columns. Omitted for explicit local_columns. Length of list and meaning: [ n=position in sequence ] [ x=sequence to be generated ] [ y=sequence given in value_sequence ] explicit x[n] = y[n] (i.e. no action!) implicit_constant x[n] = a implicit_linear x[n] = a + b * (n-1) implicit_saw x[n] = a + b * ((n-1) mod c) raw_linear x[n] = a + b * y[n] raw_polynomial x[n] = a + b * y[n] + c * y[n]^2 + ... formula x[n] is calculated elsewhere based on y[1] |
values | DT_UNKNOWN | no | no | yes | no | A value_sequence containing a value for each “measured point“, the number of values is given in the attribute “number_of_rows” in the submatrix. Omitted for implicit local columns. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoLocalColumn Base References
AoLocalColumn is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoExternalComponent |
S[0:?] | external_component | local_column |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoLocalColumn is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoSubmatrix |
Mandatory S[1:1] | submatrix | local_columns |
AoLocalColumn informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurementQuantity |
Mandatory S[1:1] | measurement_quantity | local_columns |
AoPhysicalDimension (ID=15, HighQSoft: 116) Next Previous Top
The base element AoPhysicalDimension is represented by the seven dimensional exponents of the SI base
dimensions length, mass, time, temperature, current, molar amount and light intensity (measured
in SI base units m, kg, s, K, A, Mol, cd). Usually many of the exponents are zero, particularly
the dimensionless units (as e.g. "%") all have exponents = 0.
Please note that several physical dimensions may exist that have the same set of exponents
AoPhysicalDimension Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional) |
length_exp | DT_LONG | no | yes | no | no | nominator of exponent for length |
mass_exp | DT_LONG | no | yes | no | no | nominator of exponent for mass |
time_exp | DT_LONG | no | yes | no | no | nominator of exponent for time |
current_exp | DT_LONG | no | yes | no | no | nominator of exponent for electric current |
temperature_exp | DT_LONG | no | yes | no | no | nominator of exponent for temperature |
molar_amount_exp | DT_LONG | no | yes | no | no | nominator of exponent for molar amount |
luminous_intensity_exp | DT_LONG | no | yes | no | no | nominator of exponent for light |
length_exp_den | DT_LONG | no | no | yes | no | optional denominator (length) |
mass_exp_den | DT_LONG | no | no | yes | no | optional denominator (mass) |
time_exp_den | DT_LONG | no | no | yes | no | optional denominator (time) |
current_exp_den | DT_LONG | no | no | yes | no | optional denominator (electric current) |
temperature_exp_den | DT_LONG | no | no | yes | no | optional denominator (temperature) |
molar_amount_exp_den | DT_LONG | no | no | yes | no | optional denominator (molar amount) |
luminous_intensity_exp_den | DT_LONG | no | no | yes | no | optional denominator (light) |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoPhysicalDimension Base References
AoPhysicalDimension can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoPhysicalDimension has no father.
AoPhysicalDimension informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUnit |
S[0:?] | units | phys_dimension |
AoQuantity (ID=11, HighQSoft: 114) Next Previous Top
The base element AoQuantity represents a named test variable with its features.
The features are (e.g.):
- unit, physical meaning
- data type of the value (Real, Integer, Boolean, String, Matrixes, and many others)
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).
AoQuantity Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
default_mq_name | DT_STRING | no | no | yes | no | Default name for a measurement quantity, to be used if no own name has been explicitly attached to the measurement quantity. |
default_datatype | DT_ENUM (datatype_enum) | no | no | yes | no | Default format in which the data is stored |
default_rank | DT_LONG | no | no | yes | no | Default rank of a tensor, number of value dimensions |
default_dimension | DS_LONG | no | no | yes | no | Default number of values for each rank |
default_type_size | DT_LONG | no | no | yes | no | Default length limit of a value, for example the maximum length of a string |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoQuantity Base References
AoQuantity can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoQuantity |
S[0:?] | successors | predecessor |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoQuantity is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoQuantity |
S[0:1] | predecessor | successors |
AoQuantity informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurementQuantity |
Mandatory S[0:?] | measurement_quantities | quantity |
 |
AoQuantityGroup |
S[0:?] | groups | quantities |
 |
AoUnit |
S[0:1] | default_unit | quantities |
AoQuantityGroup (ID=12, HighQSoft: 117) Next Previous Top
The base element AoQuantityGroup describes the features of a quantity set. One quantity may belong to
many quantity groups. This allows to create a net of relationships between quantities.
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".
AoQuantityGroup Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoQuantityGroup Base References
AoQuantityGroup can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoQuantityGroup has no father.
AoQuantityGroup informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoQuantity |
Mandatory S[0:?] | quantities | groups |
AoTestEquipment (ID=23, HighQSoft: 110) Next Previous Top
The base element AoTestEquipment together with AoTestEquipmentPart is used
to describe the instrumentation of a test bench or measurement system.
AoTestEquipment Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTestEquipment Base References
AoTestEquipment is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestEquipmentPart |
S[0:?] | children | parent_equipment |
 |
AoTestDevice |
S[0:?] | children | parent_equipment |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTestEquipment is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoEnvironment |
S[0:1] | environment | equipments |
AoTestEquipment informational relations:
AoTestEquipmentPart (ID=24, HighQSoft: 111) Next Previous Top
The base element AoTestEquipmentPart together with AoTestEquipment is used
to describe the instrumentation of a test bench or measurement system.
AoTestEquipmentPart Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTestEquipmentPart Base References
AoTestEquipmentPart is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestEquipmentPart |
S[0:?] | children | parent_equipment_part |
 |
AoTestDevice |
S[0:?] | children | parent_equipment_part |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTestEquipmentPart is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestEquipment |
S[1:1] | parent_equipment | children |
 |
AoTestEquipmentPart |
S[1:1] | parent_equipment_part | children |
AoTestEquipmentPart informational relations:
AoTestDevice (ID=37, HighQSoft: 123) Next Previous Top
The base element AoTestDevice represents an ASAM GDI test device.
AoTestDevice Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTestDevice Base References
AoTestDevice is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestDevice |
S[0:?] | children | parent_equipment_part |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTestDevice is child of:
AoTestDevice informational relations:
AoTestSequence (ID=25, HighQSoft: 112) Next Previous Top
The base element AoTestSequence together with AoTestSequencePart is used
to describe the different steps required to do a specific test or measurement.
AoTestSequence Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTestSequence Base References
AoTestSequence is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestSequencePart |
S[0:?] | children | parent_sequence |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTestSequence is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoEnvironment |
S[0:1] | environment | sequences |
AoTestSequence informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
S[0:?] | measurement | sequences |
AoTestSequencePart (ID=26, HighQSoft: 113) Next Previous Top
The base element AoTestSequencePart together with AoTestSequence is used
to describe the different steps required to do a specific test or measurement.
AoTestSequencePart Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoTestSequencePart Base References
AoTestSequencePart is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestSequencePart |
S[0:?] | children | parent_sequence_part |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoTestSequencePart is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoTestSequence |
S[1:1] | parent_sequence | children |
 |
AoTestSequencePart |
S[1:1] | parent_sequence_part | children |
AoTestSequencePart informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
S[0:?] | measurement | sequences |
AoUnitUnderTest (ID=21, HighQSoft: 108) Next Previous Top
The base element AoUnitUnderTest together with AoUnitUnderTestPart is used
to describe the test candidate.
AoUnitUnderTest Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUnitUnderTest Base References
AoUnitUnderTest is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUnitUnderTestPart |
S[0:?] | children | parent_unit_under_test |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUnitUnderTest is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoEnvironment |
S[0:1] | environment | uuts |
AoUnitUnderTest informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
S[0:?] | measurement | units_under_test |
AoUnitUnderTestPart (ID=22, HighQSoft: 109) Next Previous Top
The base element AoUnitUnderTestPart together with AoUnitUnderTest is used
to describe the test candidate.
AoUnitUnderTestPart Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUnitUnderTestPart Base References
AoUnitUnderTestPart is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUnitUnderTestPart |
S[0:?] | children | parent_unit_under_test_part |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUnitUnderTestPart is child of:
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_part | children |
AoUnitUnderTestPart informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoMeasurement |
S[0:?] | measurement | units_under_test |
AoUnit (ID=13, HighQSoft: 115) Next Previous Top
This entity specifies in which unit a measurement quantity has been measured. While the
AoPhysicalDimension is constant (e.g. mass) the units may vary (e.g. "g", "mg", "kg", "lbs").
"Units", which refer to the same AoPhysicalDimension, can be converted to each other by
means of 'Unit Offset' and 'Unit Factor'. Two units may refer to the same physical dimension,
only if the conversion between these units makes sense.
AoUnit Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
factor | DT_DOUBLE | no | yes | no | no | Factor to get the SI unit |
offset | DT_DOUBLE | no | yes | no | no | Offset to get the SI unit |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUnit Base References
AoUnit can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUnit has no father.
AoUnit informational relations:
AoUnitGroup (ID=14, HighQSoft: 118) Next Previous Top
The base element AoUnitGroup allows grouping of "units" according to free criteria.
Examples: "MKS", "USA", "outdated".
AoUnitGroup Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUnitGroup Base References
AoUnitGroup can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUnitGroup has no father.
AoUnitGroup informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUnit |
Mandatory S[0:?] | units | groups |
AoUser (ID=34, HighQSoft: 119) Next Previous Top
The base element AoUser denotes an individual user as used by a client for identification when
accessing data via the ODS interface.
AoUser Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
password | DT_STRING | no | yes | no | no | Contains the password, normally MD5 encoding. Password is not available at the normal methods of the API. |
ao_disabled | DT_SHORT | no | no | yes | no | Indicate the user is disabled (1) or enabled (all other cases), no access is granted to the disabled user. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUser Base References
AoUser can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUser has no father
AoUser informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUserGroup |
Mandatory S[0:?] | groups | users |
AoUserGroup (ID=35, HighQSoft: 124) Next Previous Top
The base element AoUerGroup will be used for grant access rights, all users which are member of the same usergroup will have the same access rights on the objects.
The following rules apply:
- A User may belong to one or more than one "User Groups".
- A User's right to access data objects is defined by his/her membership to User Groups.
Exactly one user group must be the super user-group. To identify the super user-group an additional mandatory
basic attribute SUPERUSER_FLAG must be included in AoUserGroup. The SUPERUSER_FLAG must be read-only
(a client must not set/change the SUPERUSER_FLAG). The "Super user" user group has automatically full
access rights to all data. Only members of this user group are allowed to add further users to the
"Super user" user group.
A Super user flag in the AoUserGroup application element identifies the Super user group. Exactly
one user group may have this flag. This must be configured (outside ODS) at the time of 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 the time of system setup. The server does not allow the removal of the last existing
user in this group.
AoUserGroup Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
superuser_flag | DT_SHORT | no | yes | no | no | Flag, which indicates whether being Superuser or not. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoUserGroup Base References
AoUserGroup can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoUserGroup has no father.
AoUserGroup informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUser |
Mandatory S[0:?] | users | groups |
AoExternalComponent (ID=40, HighQSoft: 40) Next Previous Top
The base element AoExternalComponent allows the storage of the required attributes for the mixed mode server.
The base attributes describe the way the values and flags are stored in the external files managed by the mixed mode
server. The following items are specified:
Attribute | Description | Name of base attribute |
Identifier | Filename (URL) | filename_url |
Type specification | Data type and byte order | value_type | Was previous type_specification |
Length specification | Number of values | component_length | Was previous length |
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) | block_size | Was previous blocksize |
ValOffsets | Offset from begin of block to respective value | value_offset | Was previous 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 |
AoExternalComponent Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ordinal_number | DT_LONG | no | no | yes | no | Ordinal Number starts with 1, INTEGER (optional) |
component_length | DT_LONG | no | yes | no | no | Length of this component; for all numeric data types it is given as
number of values, for the other data types it is given as number of bytes. |
filename_url | DT_STRING | no | yes | yes | no | URL of the File Name, STRING |
value_type | DT_ENUM (typespec_enum) | no | yes | no | no | Specification of the type of the values in the file, typespec_enum specifies the data type and byte order of the values. |
start_offset | DT_LONGLONG | no | yes | yes | no | Start offset of the first block in bytes from the beginning of the file, allowed also datatype DT_LONG |
block_size | DT_LONG | no | yes | yes | no | Block size, INTEGER |
valuesperblock | DT_LONG | no | yes | yes | no | Values per Block, INTEGER |
value_offset | DT_LONG | no | yes | yes | no | Value offset in a block, INTEGER |
flags_filename_url | DT_STRING | no | no | yes | no | URL of the File Name with Flags, STRING (optional) |
flags_start_offset | DT_LONGLONG | no | no | yes | no | Offset where the Flags begins in bytes from the beginning of the file, allowed also datatype DT_LONG (optional) |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
ao_bit_count | DT_SHORT | no | no | yes | no | Number of bits stored in the external component file for each value |
ao_bit_offset | DT_SHORT | no | no | yes | no | Number of bit shifts to the right that must be performed; will be between 0 and 7 (including) |
AoExternalComponent Base References
AoExternalComponent can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoExternalComponent is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoLocalColumn |
Mandatory S[1:1] | local_column | external_component |
AoExternalComponentinformational relations::
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:1] | ao_values_file | ao_extcomp_values |
 |
AoFile |
S[0:1] | ao_flags_file | ao_extcomp_flags |
AoAny (ID=0, HighQSoft: 100)
Next Previous Top
The base element AoAny is intended for information that does not fit into the defined ASAM ODS
data structure. This base element should be used with great care, because applications may not
be able to interpret what the content of this element means.
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.
AoAny Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoAny Base References
AoAny is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoAny |
S[0:?] | children | parent |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoAny is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoAny |
S[0:1] | parent | children |
AoAny has no informational relations.
AoLog (ID=43, HighQSoft: 43)
Next Previous Top
The base element AoLog is used to create logbooks in ASAM ODS data storages.
AoLog Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
date | DT_DATE | no | yes | yes | no | Date of the Logbook entry, T_DATE |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoLog Base References
AoLog is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoLog |
S[0:?] | children | parent |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoLog is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoLog |
S[0:1] | parent | children |
AoLog has no informational relations.
AoParameterSet (ID=45, HighQSoft: 45)
Next Previous Top
The AoParameterSet is a “grouping object” for parameters. It holds a set of AoParameter
referring to it. Base attributes are the standard ODS base attributes.
AoParameterSet Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoParameterSet Base References
AoParameterSet is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoParameter |
Mandatory S[0:?] | parameters | parameter_set |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoParameterSet has no father.
AoParameterSet has no informational relations.
AoParameter (ID=44, HighQSoft: 44)
Next Previous Top
AoParameter holds one parameter of any ODS-conform type. It has a name (the name of the
parameter) and a value (of any type). Base attributes are besides the standard ODS base
attributes:
pvalue: the value of the instance, stored as a string representation.
parameter_datatype: The data type of pvalue, given as enumeration value out of the
possible values of the DataType enumeration. It is used to interpret pvalue correctly.
AoParameter Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
parameter_datatype | DT_ENUM (datatype_enum) | no | yes | no | no | The datatype of the parameter. |
pvalue | DT_STRING | no | yes | no | no | T_STRING (always string, other types are converted). In case of DT_ENUM, is the first word the enumeration item followed by the enumeration name in brackets. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoParameter Base References
AoParameter can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoParameter is child of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoParameterSet |
Mandatory S[0:1] | parameter_set | parameters |
AoParameter informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoUnit |
S[0:1] | unit | parameters |
AoNameMap (ID=46, HighQSoft: 46)
Next Previous Top
The base element AoNameMap description is: For the entity name any number of alias names (e.g. for
language versions) may be specified.
The list allows different language version switched by
the application software.
The length of the list shall be equal to the list
"meaning_of_aliases" in AoEnvironment.
For each entity a name mapping may be given;
for each attribute of the entity an attribute mapping may be given
AoNameMap Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | yes | Name of the instance |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
entity_name | DT_STRING | no | yes | no | yes | Name of the application element which name will be mapped. |
alias_names | DS_STRING | no | yes | yes | no | The mapped names of the application elemment, the length of the list shall be equal to the list 'meaning_of_aliases' in AoEnvironment. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoNameMap Base References
AoNameMap is father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoAttributeMap |
Mandatory S[0:?] | attribute_mapping | name_mapping |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoNameMap has no father.
AoNameMap informational relations:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoEnvironment |
Mandatory S[1:1] | environment | entity_mapping |
AoAttributeMap (ID=47, HighQSoft: 47)
Next Previous Top
Each AoAttributeMap contains one attribute of an application element respectively.
If an attribute was derived from a base attribute, the corresponding relation is
also stored. It is further possible to build a list of alias names and to define
a unit and a relation to a quantity. Each instance of AoAttributeMap specifies any
number of alias names for the attribute "attribute_name". The length of the list of
alias names shall be equal to the length of that list in AoNameMap.
AoAttributeMap Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
attribute_name | DT_STRING | no | yes | no | no | Name of the application attribute which name will be mapped. |
alias_names | DS_STRING | no | yes | yes | no | The mapped names of the application attribute, the length of the list shall be equal to the list 'meaning_of_aliases' in AoEnvironment. |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
AoAttributeMap Base References
AoAttributeMap can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoAttributeMap is child of::
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoNameMap |
Mandatory S[1:1] | name_mapping | attribute_mapping |
AoAttributeMap has no informational relations.
AoFile (ID=48, HighQSoft: 48)
Next Previous Top
The base element AoFile is meant to represent files in the ODS server namespace that are
under control of the ODS server. One instance of an application element derived from AoFile
represents exactly one physical file. No two instances may represent the same physical file.
In an application model any number of application elements may be derived from this base
element (multiple derivation).
The combination of the attributes derived from 'name' and 'version' must be unique for all
instances of an application element in an ODS server.
It is recommended to not use the attribute 'external_references'. AoFile is meant to represent
files that are under control of the ODS server, and it would be contradictory to its purpose if it
references files (through 'external_references') that are not under control of the ODS server.
If a file needs a reference to another file, an application relation to an application element of
type AoFile should be used instead and its instances should use this application relation to
reference each other.
The attribute derived from 'ao_file_mimetype' may be used to specify the MIME type of the
file. This allows e.g. to determine an application that is capable to work with the file.
The attribute derived from 'ao_location' is used to store the physical location of the file within
the ODS server namespace; its value is solely set by the ODS server when creating the file
on server side. Though the location of the file can
be retrieved by clients through this attribute, it is usually not possible for them to access the
file directly as they would not have access rights to such location in the server namespace.
The attribute derived from 'ao_size' is used to store the size of the file (in bytes). It is solely
set and adapted by the ODS server (e.g. when writing to the file occurs through the interface
ODSWriteTransfer).
The attribute derived from 'ao_original_filename' may be used to store the original name of
the file as it appeared on client side at the time when the file was put under control of the
ODS server. This information may help to restore the file under its original name when
reading it by a client. There are no rules specified by ODS regarding the syntax of this string,
and it is thus left to a client application to determine whether the string includes information
on drive, directory path, etc..
The attribute derived from 'ao_original_filedate' shall hold the date of the original physical file
as given by the underlying operating system at client side. This is preferrably the date of the
latest change, if it is available. If the underlying operating system does not provide this date
information, the attribute shall hold a value that is as close as possible to that information.
The relation derived from 'ao_extcomp_values' is used in case instances of an application
element derived from AoExternalComponent put their external component files for local
column values under control of the ODS server. In this case such application relation must
exist in an application model.
If the current instance represents a file that contains values for any external component, this
relation may not be empty but must contain a valid reference to each external component
which uses this file for values.
The relation derived from 'ao_extcomp_flags' is used in case instances of an application
element derived from AoExternalComponent put their external component files for local
column value flags under control of the ODS server. In this case such application relation
must exist in an application model.
If the current instance represents a file that contains value flags for any external component,
this relation may not be empty but must contain a valid reference to each external
component which uses this file for value flags.
AoFile Base Attributes
Base Attributes | Datatype | Key | Mandatory | Optional | Unique | Meaning |
id | DT_LONGLONG | yes | yes | no | yes | Unique ID for the instances of an application element |
name | DT_STRING | yes | yes | no | no | Name of the instance, only unique within its predecessor in a hierarchy |
description | DT_STRING | no | no | yes | no | Describing text for the instance (optional) |
version | DT_STRING | no | no | yes | no | Version of the instance (optional) |
version_date | DT_DATE | no | no | yes | no | Date of the version change (optional) |
mime_type | DT_STRING | no | no | yes | no | The MIME type of the instance (optional) |
external_references | DS_EXTERNALREFERENCE | no | no | yes | no | LIST [0:?] of references to external information |
objecttype | DT_LONGLONG | no | no | yes | no | Contains the ID of the application element (subclass or superclass) to which the instance belongs (optional). |
ao_created | DT_DATE | no | no | yes | no | The date/time the instance is created. (The attribute value is autogenerated by the server) |
ao_created_by | DT_STRING | no | no | yes | no | The user which created the instance. (The attribute value is autogenerated by the server) |
ao_last_modified | DT_DATE | no | no | yes | no | The date/time the instance is last modified. (The attribute value is autogenerated by the server) |
ao_last_modified_by | DT_STRING | no | no | yes | no | The user which did the last modification of the instance. (The attribute value is autogenerated by the server) |
ao_file_mimetype | DT_STRING | no | no | yes | no | The MIME type of the physical file. |
ao_location | DT_STRING | no | yes | yes | yes | The location of the physical file within the ODS server namespace. (The attribute value is autogenerated by the server) |
ao_size | DT_LONGLONG | no | no | yes | no | The size of the physical file, given as number of bytes. (The attribute value is autogenerated by the server) |
ao_original_filename | DT_STRING | no | no | yes | no | The original name of the file at client side. |
ao_original_filedate | DT_DATE | no | no | yes | no | The date of the file at client side before it was sent to the server. |
AoFile Base References
AoFile can be father of:
Icon | Base Element Name | Cardinality | Reference Name | Inverse Reference Name |
 |
AoFile |
S[0:?] | ao_file_children | ao_file_parent |
AoFile can be child of all elements, the relation is used for inheritance of rights and recursive delete:
AoFile informational relations::
seq_rep_enum
Next Previous Top
This enumeration is used to classify sequence representation of a column.
Name | Value |
explicit | 0 |
implicit_constant | 1 |
implicit_linear | 2 |
implicit_saw | 3 |
raw_linear | 4 |
raw_polynomial | 5 |
formula | 6 |
external_component | 7 |
raw_linear_external | 8 |
raw_polynomial_external | 9 |
raw_linear_calibrated | 10 |
raw_linear_calibrated_external | 11 |
datatype_enum
Next Previous Top
An enumeration to classify a datatype.
Name | Value |
DT_UNKNOWN | 0 |
DT_STRING | 1 |
DT_SHORT | 2 |
DT_FLOAT | 3 |
DT_BOOLEAN | 4 |
DT_BYTE | 5 |
DT_LONG | 6 |
DT_DOUBLE | 7 |
DT_LONGLONG | 8 |
DT_ID | 9 |
DT_DATE | 10 |
DT_BYTESTR | 11 |
DT_BLOB | 12 |
DT_COMPLEX | 13 |
DT_DCOMPLEX | 14 |
DT_EXTERNALREFERENCE | 28 |
DT_ENUM | 30 |
typespec_enum
Next Previous Top
An enumeration to classify the value type of an external component.
Name | Value |
dt_boolean | 0 |
dt_byte | 1 |
dt_short | 2 |
dt_long | 3 |
dt_longlong | 4 |
ieeefloat4 | 5 |
ieeefloat8 | 6 |
dt_short_beo | 7 |
dt_long_beo | 8 |
dt_longlong_beo | 9 |
ieeefloat4_beo | 10 |
ieeefloat8_beo | 11 |
dt_string | 12 |
dt_bytestr | 13 |
dt_blob | 14 |
dt_boolean_flags_beo | 15 |
dt_byte_flags_beo | 16 |
dt_string_flags_beo | 17 |
dt_bytestr_beo | 18 |
dt_sbyte | 19 |
dt_sbyte_flags_beo | 20 |
dt_ushort | 21 |
dt_ushort_beo | 22 |
dt_ulong | 23 |
dt_ulong_beo | 24 |
dt_string_utf8 | 25 |
dt_string_utf8_beo | 26 |
dt_bit_int | 27 |
dt_bit_int_beo | 28 |
dt_bit_uint | 29 |
dt_bit_uint_beo | 30 |
dt_bit_ieeefloat | 31 |
dt_bit_ieeefloat_beo | 32 |
dt_bytestr_leo | 33 |
interpolation_enum
Next Previous Top
This enumeration is used to classify the interpolation attribute of the measurement quantity.
Name | Value |
no_interpolation | 0 |
linear_interpolation | 1 |
application_specific | 2 |
ao_storagetype_enum
Previous Top
This enumeration is used to classify the way the values of the measurement are stored.
Name | Value |
database | 0 |
external_only | 1 |
mixed | 2 |
foreign_format | 3 |