Location.xid.xml 2.81 KB
<?xml version="1.0" encoding="UTF-8" ?>

<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
               xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
               identity="Location.xid.xml">
  <title>GeoSpatial Location Definition </title>

  <!-- Include all known definitions -->
  <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
  <import ref="https://xid.location.studio/GeoSpatial/V1.0/SpatialDefs.xid.xml" local="SpatialDefs.xid.xml" />
  <import ref="https://xid.location.studio/GeoSpatial/V1.0/Address.xid.xml" local="Address.xid.xml" />
  <import ref="https://xid.location.studio/GeoSpatial/V1.0/Shape.xid.xml" local="Shape.xid.xml" />

  <namespace name="GeoSpatial">
    <using namespace="Tensor"/>

    <!-- 
    *************************************
    * Location Definition. 
    *************************************
    -->
    <struct name="Location" type="Object" rttkey="GeoSpatial.ObjectType.Location">
      <comment>Defines a simple location object comprising a shape with optional name, identity, and address information.  Location is typically
      used to convey basic information about a place.  More complex types with uncertainty, confidence, bounds are available in in GeoObject and HPE positioning
      definitions.</comment>

      <elem name="shape" type="Shape" multiplicity="1" polymorphic="true" ord="21">
        <comment>
          The shape of the location.  Can be any of the shape types.
        </comment>
      </elem>
     
      <elem name="veracity" type="float32" multiplicity="1" default="-1" ord="22">
        <comment>
          Veracity defines the validity of the measurement in the range between 0 and 1.
          A high score means the estimate is deemed valid and more reliable than a lower score.
          If no veracity scoring is performed, this will have a value of -1.
        </comment>
      </elem>
      
      <elem name="confidence" type="float32" multiplicity="1" default="-1" ord="23">
        <comment>The estimate confidence.  Valid range is 0.0 to 1.0.  Typical value is 0.68 (one standard deviation).   Default is -1 for not defined.</comment>
      </elem>

      <elem name="address" type="GeoSpatial.AddressInfo" multiplicity="0..1" ord="24">
        <comment>Optional address associated with the GeoObject.</comment>
      </elem>

      <elem name="floor" type="int16" multiplicity="0..1" default="0" ord="25">
        <comment>Optional floor number</comment>
      </elem>
     
    </struct>
  </namespace>
</specification>