tml:responseModels

Element Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
name xs:string optional
short descriptive name of element
uid xs:anyURI optional
unique ID for this element
uidRef xs:anyURI optional
the contents of this element are exactly the same as the contents of the uidRef element. no need repeating it. (similar to xlink)

Used By

Source

<xs:element name="responseModels">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="tml:cfSubSampling" minOccurs="0"/>
      <xs:element name="steadyStateResponse" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>input to output mapping. one or more mappings for each dataUnit. Can have property-property, property-data, or data-property mappings. property-property-property and property-property-data mappings are also allowed as long as independent property values can be found somewhere. Separate mappings can be used for different hystersis directions or for non-continuous or broken functions.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="responseParameters" minOccurs="0">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="codePlot" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Allowed values code, plot. Default: plot</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="hysteresisDirection" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>allowed values: increasing, decreasing, both. default both</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="calibrated" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Is response calibrated, or is response a relative reading? true of false. Default: true</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="proportional" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>For uncalibrated responses is the output proportional to the input? true of false. Mult factors can also reflect prop or inversely prop for calibrated responses. Default: true.</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="invertability" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>a process input can be determined from its output. Allowed Values: true, false. default true</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="timeInvariant" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>a time shift in the input only results in a time shift in the output. Allowed Values: true, false. default true</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="linear" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>allowed values: true or false. do not need explicit Phen plot values if linear is true. Phen and data mult and offset can be used if there are no limits. default true</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="interCfInterpolate" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Allowed values: continuous, discrete, lastValue, returnToZero. how to interpolate between corresponding data values between adjacent CF's. default is continuous</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                  <xs:element name="intraCfInterpolate" type="tml:BindType" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Allowed values: continuous, discrete, lastValue, returnToZero. how to interpolate between data values within a CF. default continuous</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="propValues" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>values for the physical property (phenomenon) axis of the input output transfer function</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType">
                    <xs:sequence>
                      <xs:element name="inputOutput" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>Is the physical property (phenomenon) the input or output for this dataUnit. Allowed values: input, output. Default: input</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="propName" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>from Physical Property (Phenomenon) Dictionary</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                          <xs:simpleContent>
                            <xs:extension base="tml:BindType">
                              <xs:attributeGroup ref="tml:uid_uidRef"/>
                            </xs:extension>
                          </xs:simpleContent>
                        </xs:complexType>
                      </xs:element>
                      <xs:element name="propQualifier" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>Qualifier for the property. From Qualifier Dictionary. e.g. aveValue, rmsValue, rssValue, instValue, accumulatedValue, rateOfChange, range, min, max...</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="UOM" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>From Units Of Measure Dictionary (SI Units)</xs:documentation>
                        </xs:annotation>
                        <xs:complexType>
                          <xs:simpleContent>
                            <xs:extension base="tml:BindType">
                              <xs:attributeGroup ref="tml:uid_uidRef"/>
                            </xs:extension>
                          </xs:simpleContent>
                        </xs:complexType>
                      </xs:element>
                      <xs:element name="direction" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>if the physical property (phenomenon) had a direction associated with it such as torque or force. direction relative to the transducer reference system. Allowed Values: horizontal, vertical, +xTranslation, -xTranslation, +yTranslation, -yTranslation, +zTranslation, -zTranslation, +alpha, -alpha, +beta, -beta, +rhoTranslation, -rhoTranslation, +latTranslation, -latTranslation, +longTranslation -longTranslation, +altTranslation, -altTranslation, +omegaRotation, -omegaRotation, +phiRotation, -phiRotation, +kappaRotation, -kappaRotation, none Default: none</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="variableName" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>Name of mathematical term used in the transformation equations.</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="calibProp" type="tml:BindType" minOccurs="0" maxOccurs="unbounded">
                        <xs:annotation>
                          <xs:documentation>If a calibrated source is available this elements identifies the calibration level or points (bindUID) to the calibrated sensor measuring the source. This is used for post correcting relative readings Default: none</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                    </xs:sequence>
                  </xs:extension>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="dataValues" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>values for the data axis of the input output transfer function</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType">
                    <xs:sequence>
                      <xs:element name="inputOutput" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>Is the data an input or an output for this dataUnit. Allowed values: input, output. Default: output</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="dataUidRef" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>uid of the data form the logical data structure (dataUnit) to which this response model corresponds</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="variableName" type="tml:BindType" minOccurs="0">
                        <xs:annotation>
                          <xs:documentation>Name of mathematical term used in the transformation equations.</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                      <xs:element name="calibData" type="tml:BindType" minOccurs="0" maxOccurs="unbounded">
                        <xs:annotation>
                          <xs:documentation>data resulting from calibrated source. or bindUID points to sensor measurement measuring calib source. Default: none</xs:documentation>
                        </xs:annotation>
                      </xs:element>
                    </xs:sequence>
                  </xs:extension>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="code" minOccurs="0">
              <xs:annotation>
                <xs:documentation>computer code of the transfer process from input to output</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="properties" minOccurs="0">
                    <xs:complexType>
                      <xs:sequence>
                        <xs:element name="codeType" type="tml:BindType" minOccurs="0">
                          <xs:annotation>
                            <xs:documentation>Allowed Values: source, exe default: source</xs:documentation>
                          </xs:annotation>
                        </xs:element>
                        <xs:element name="codeLanguage" type="tml:BindType" minOccurs="0">
                          <xs:annotation>
                            <xs:documentation>Allowed Values: C, C++, Java, Fortran, C Sharp, Basic, Visual Basic. Default: C</xs:documentation>
                          </xs:annotation>
                        </xs:element>
                      </xs:sequence>
                    </xs:complexType>
                  </xs:element>
                  <xs:element name="listing" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Listing of code. Base64 encoded executable or source code with unallowed XML characters escaped out</xs:documentation>
                    </xs:annotation>
                    <xs:complexType>
                      <xs:simpleContent>
                        <xs:extension base="tml:BindType"/>
                      </xs:simpleContent>
                    </xs:complexType>
                  </xs:element>
                </xs:sequence>
                <xs:attributeGroup ref="tml:uid_uidRef"/>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
          <xs:attributeGroup ref="tml:uid_uidRef"/>
        </xs:complexType>
      </xs:element>
      <xs:element name="impulseResponse" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>time domain or frequency domain impulse characteristics for linear time invariant transforms. May have a separate response for each dataUnit and for each type (freq and time). Or dataUnits within a data Set may share the same response.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="dataUidRef" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>same as uidRef in attributes</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="freqTime" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: freq, time. default is time. indicates if frequency of time domain descriptions.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="amplitude" minOccurs="0">
              <xs:annotation>
                <xs:documentation>amplitude dependent axis.</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType"/>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="time" minOccurs="0">
              <xs:annotation>
                <xs:documentation>time domain independent axis.</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType"/>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="frequency" type="tml:ValueType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>frequency domain independent axis.</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
          <xs:attributeGroup ref="tml:uid_uidRef"/>
        </xs:complexType>
      </xs:element>
      <xs:element name="frequencyResponse" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>one for each dataUnit and for each type of freqResp (carrier, modulation, and powerSpectrialDensity) and each type of plot amp vs freq and phase vs freq (can combine plots onto one as well)</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="dataUidRef" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>same as uidRef in attributes</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="freqRespType" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: carried, modulation, PSD (pwrSpectralDensity). default carrier</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="amplitude" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Set of point coordinates describing amplitude dependent axis</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType"/>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="phase" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Set of point coordinates describing phase dependent axis</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType"/>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
            <xs:element name="frequency" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Set of point coordinates describing frequency independent axis</xs:documentation>
              </xs:annotation>
              <xs:complexType>
                <xs:complexContent>
                  <xs:extension base="tml:ValueType"/>
                </xs:complexContent>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
          <xs:attributeGroup ref="tml:uid_uidRef"/>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attributeGroup ref="tml:uid_uidRef"/>
  </xs:complexType>
</xs:element>

Sample