REXS Specification

Components are described in the interface file with the <component></component> XML tag.

The contents of the tag are the attributes associated with the component.

Example components | XML syntax

<components>
	<component id="4" type="cylindrical_gear" name="Pinion">
		<attribute id="attr1"> .. </attribute>
		<attribute id="attr2"> .. </attribute>
		...
	</component >
	<component id="6" type="cylindrical_gear" name="Wheel">
		<attribute id="attr1"> .. </attribute>
		<attribute id="attr2"> .. </attribute>
		...
	</component >
</components>

If arrays and matrices exceed a certain size, it may be practical to save them in the REXS file in binary format for performance reasons.

An array is first converted into binary format. The byte order is "Little Endian.“ In the second step, the byte array is then converted into a string using base64 encoding. This string is then available in the REXS file. The binary format used must also be indicated (int32, float64, or float32).

The procedure for encoding of matrices is as follows: first, the 2d matrix is converted column-by-column into a 1d array (array = [column1, column2, ...]). This is then converted to binary format as described above (the byte order is "Little Endian“) and finally converted to a string using base64 encoding. In addition to specification of the binary format (int32, float64, float32), specification of the number of rows and columns of the matrix is also required.

For more information on identification of base64 encoded attributes in the REXS file, see XML syntax, JSON syntax, and Code examples

Example string attribute | XML syntax

<attribute id="name">30203-A</attribute>

Example double-attribute with unit | XML syntax

<attribute id="normal_module" unit="mm">23.5</attribute>

Example double-attribute without unit | XML syntax

<attribute id="addendum_modification_coefficient" unit="none">0.5</attribute>

Example attribute with origin="user_defined" | XML syntax

<attribute id=addendum_modification_coefficient" unit="none" origin="user_defined">0.5</attribute>

Example attribute with origin="calculated" | XML syntax

<attribute id=addendum_modification_coefficient" unit="none" origin="calculated">0.5</attribute>

Example integer attribute without unit | XML syntax

<attribute id="number_of_teeth" unit="none">8</attribute>

Example boolean attribute | XML syntax

<attribute id="is_driving_gear">false</attribute>

Example enum attribute | XML syntax

<attribute id="axial_force_absorption">both_directions</attribute>

Example array attribute | XML syntax

<attribute id="support_vector" unit="mm">
	<array>
		<c>1.0</c>
		<c>1.0</c>
		<c>0.0</c>
	</array>
</attribute>

Example matrix attribute | XML syntax

<attribute id="matrix_correction" unit="mm">
	<matrix>
		<r>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
		</r>
		<r>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
		</r>
			...
		<r>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
			<c>0.0</c>
		</r>
	</matrix>
</attribute>

Example array attribute in binary format | XML syntax

<attribute id="example_attribute_id" unit="mm">
	<array code="float64"/>62wRNhgQS0AAAAAAAAAAANgPsyG1MXDA=<array/>
</attribute>

Example matrix attribute in binary format | XML syntax

<attribute id="example_matrix_coded" unit="mm">
        <matrix code="float64" columns="3" rows="2">AAAAAAAA8D8AAAAAAAAQQAAAAAAAAABAAAAAAAAAFEAAAAAAAAAIQAAAAAAAABhA</matrix>
</attribute>

Example array_of_integer_arrays attribute | XML syntax

<attribute id="element_structure" unit="none">
	<array_of_arrays>
		<array><c>108</c><c>2</c><c>1</c><c>107</c></array>
		<array><c>109</c><c>3</c><c>2</c><c>108</c></array>
		<array><c>8</c><c>114</c><c>115</c></array>
	</array_of_arrays>
</attribute>

The "attributes" array contains a list of objects with the following name-value pairs: "id" (attribute ID), "unit" (unit, required for certain data types), "origin" (optional, identifies the attribute as "calculated" or "user_defined"), and the attribute value. Different identifiers are used to enable JSON validation, depending on the data type. The available identifiers are listed below. For details on binary-coded arrays and matrices, see Note and Note.

Example attribute list | JSON syntax

"attributes":[
	{"id": "name", "string": "30203-A"},
	{"id": "normal_module", "unit": "mm", "floating_point": 2.0},
	{"id": "addendum_modification_coefficient", "unit": "none", "floating_point": 0.1},
	{"id": "addendum_modification_coefficient", "unit": "none", "origin":"user_defined", "floating_point": 0.1},
	{"id": "addendum_modification_coefficient", "unit": "none", "origin":"calculated", "floating_point": 0.1},
	{"id": "number_of_gears", "integer": 3},
	{"id": "is_driving_gear", "boolean": false},
	{"id": "axial_force_absorption", "enum": "both_directions" },
	{"id": "u_axis_vector", "unit": "mm","floating_point_array": [1.0,0.0,0.0]},
	{"id": "matrix_correction", "unit": "mm", "floating_point_matrix": [[1.0,0.0,0.0],[0.0,1.0,0.0],[0.0,0.0,1.0]] },
	{"id": "example_array_coded", "unit": "mm", "floating_point_array_coded": {"code": "float64", "value": "62wRNhgQS0AAAAAAAAAAANgPsyG1MXDA"}},
	{"id": "example_matrix_coded", "unit": "mm", "floating_point_matrix_coded": {"code": "float64", columns="3", rows="2", "value": "AAAAAAAA8D8AAAAAAAAQQAAAAAAAAABAAAAAAAAAFEAAAAAAAAAIQAAAAAAAABhA62wRNhgQS0AAAAAAAAAAANgPsyG1MXDA"}},
	{"id": "element_structure", "array_of_integer_arrays": [[108,2,1,107,7],[0,1,0],[0,7,0,1]]},
]