tml:binHeaderEncode

If cluster type is binary this field describes the encoding of the header attributes. binary files will contain only the contents of the attributes and not the attribute tag.  The binary header will not contain the left carrot and the letters "data" at the beginning of the header either, nor the right carrot at the end of the header.

Element Information

Model

Source

<xs:element name="binHeaderEncode" minOccurs="0">
  <xs:annotation>
    <xs:documentation>If cluster type is binary this field describes the encoding of the header attributes. binary files will contain only the contents of the attributes and not the attribute tag. The binary header will not contain the left carrot and the letters "data" at the beginning of the header either, nor the right carrot at the end of the header.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="headerAttrib" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>ref, reference, dateTime, contents and ismClass attributes will be encoded and handled as "string" type</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="headerAttribName" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: ref, clk, reference, dateTime, contents, seq, total, ismClass. Default ref</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="dataType" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: text, number. Default is number.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="dataUnitFieldSize" minOccurs="0">
              <xs:complexType>
                <xs:choice>
                  <xs:sequence>
                    <xs:annotation>
                      <xs:documentation>if fixed field size. Default is fixed size.</xs:documentation>
                    </xs:annotation>
                    <xs:element name="numBits" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>number of bits. default 8</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                    <xs:element name="numSigBits" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>number of significant bits. default 8</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                    <xs:element name="justification" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>if numSigBits is less than numBits this element indicates how sigbit are justified. Allowed values: left, right. Default: right</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                  </xs:sequence>
                  <xs:sequence>
                    <xs:annotation>
                      <xs:documentation>if field is variable size.</xs:documentation>
                    </xs:annotation>
                    <xs:element name="beginTextDelimiter" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>delimiter used to separate variable size dataUnits in cluster when encode is text (utf or ucs). default delimiter is none. empty tag means none.</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                    <xs:element name="endTextDelimiter" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>delimiter used to separate variable size dataUnits in cluster when encode is text (utf or ucs). default delimiter is none. Empty tag means none</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                  </xs:sequence>
                </xs:choice>
              </xs:complexType>
            </xs:element>
            <xs:element name="endian" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: big, little. default little</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="encode" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: ucs16, utf8, signInt, unsignInt, real, bcd. default unsignInt.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="numBase" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>when numbers are encoded as text the number base must be understood. Allowed values: 2, 8, 10, 16, 32, 64, 128. default 10</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="handleAsType" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>how should the text or number be handled in the client application. Allowed values: anuURI, boolean, byte, double, float, short, string, int, integer, long, nonNegativeInteger, nonPositiveInteger, positiveInteger, unsignedByte, unsignedInt, unsignedShort, unsignedLong.</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
          <xs:attributeGroup ref="tml:uid_uidRef"/>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>

Sample