Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
78ac6a27 by Michael B. Mathews
Options

ILP-593 Added IlpTestApi

1 parent 2c6a94a7
Inline Side-by-side
Showing 2 changed files with 260 additions and 0 deletions
GeoSpatial/V1.0/SpatialDefs.xid.xml
......@@ -98,6 +98,18 @@
</elem>
</struct>
<!--
*************************************
* XYZVector Definition.
*************************************
-->
<array name="XYZVector" type="float64" size="3" >
<comment>
Defines 3D Cartesian Vector data array.
</comment>
</array>
<!--
*************************************
* Object Definition.
......
ILP/V1.2/IlpTestApi.xid.xml 0 → 100644
<?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 https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
identity="TestSpec.xid.xml">
<title>ILP Test Spec Specifications</title>
<comment>
This file defines the ILP test specification Used by the Test Service.
</comment>
<!-- Include all known definitions -->
<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/Contact.xid.xml" local="Contact.xid.xml" />
<import ref="https://xid.location.studio/SLAM/V1.0/SurveyApi.xid.xml" local="SurveyApi.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<namespace name="ILP.Test">
<using namespace="Tensor"/>
<!--
*************************************
* Filter Structure Definition
*************************************
-->
<struct name="Filter">
<comment>Specifies filter parameters controlling selection of records in the Data Set.</comment>
<elem name="obsTypes" multiplicity ="0..*" type="uint8" >
<comment>Optional set of observation types to use in execution. If not defined, all observation types will be passed to ILP. This filter
limits the data presented to the ILP.</comment>
</elem>
<elem name="earliestDate" type="datetime" multiplicity="0..1">
<comment>Optional earliest date to select records. If not defined, earliest date is not considered.</comment>
</elem>
<elem name="latestDate" type="datetime" multiplicity="0..1">
<comment>Optional latest date to select records. If not defined, latest date is not considered.</comment>
</elem>
<elem name="bounds" multiplicity ="0..1" type="GeoSpatial.BoundingBox" >
<comment>Optional bounding box, which the records are contained.</comment>
</elem>
<elem name="devids" multiplicity ="0..*" type="string" default ="0">
<comment>Optional set of device idenifers to select for execution.</comment>
</elem>
</struct>
<!--
*************************************
* DataSet Structure Definition.
*************************************
-->
<struct name="DataSet" type="GeoSpatial.Object" rttkey="GeoSpatila.ObjectType.IlpTestDataSet">
<comment>DataSet comprises one or more surveys to use as test records.</comment>
<elem name="uuidData" multiplicity ="0..*" type="UUID" >
<comment>Zero or more UUIDs identifying the survey test data to include in this data set.</comment>
</elem>
<elem name="data" multiplicity ="0..*" type="SLAM.Survey" >
<comment>Zero or more SLAM surveys comprising the test data to execute.</comment>
</elem>
<elem name="returnFilteredData" multiplicity ="1" type="bool" default ="false">
<comment>Optional boolean, determines if filtered data should be returned to caller for future testing.</comment>
</elem>
</struct>
<!--
*************************************
* Specification Structure Definition.
*************************************
-->
<struct name="Specification" type="GeoSpatial.Object" rttkey="GeoSptila.ObjectType.IlpTestSpecification">
<comment>Specification for an ILP Test comprising one or more data sets.</comment>
<elem name="createDate" type="datetime" multiplicity="1">
<comment>Date and time the test specification was created.</comment>
</elem>
<elem name="modifiedDate" type="datetime" multiplicity="1">
<comment>Date and time the test specification was modified.</comment>
</elem>
<elem name="contact" multiplicity ="0..1" type="GeoSpatial.ContactInfo" >
<comment>Optional contact information.</comment>
</elem>
</struct>
<!--
*************************************
* ResultRecord Definition.
*************************************
-->
<struct name="ResultRecord" >
<comment>Result Record contains detailed results of position calculation and information relative to truth.</comment>
<elem name="index" type="uint32" multiplicity="1" />
<elem name="epoch" type="datetime" multiplicity="1" />
<elem name="resultcode" type="ResultCode" multiplicity="1" />
<elem name="status" type="HPE.ProcessingStatus" multiplicity="1" />
<elem name="epoch" type="datetime" multiplicity="1" />
<elem name="source" type="string" multiplicity="1" />
<elem name="stateTruth" type="HPE.StateVector" multiplicity="1" />
<elem name="stateEst" type="HPE.StateVector" multiplicity="1" />
<elem name="stateUncert" type="HPE.StateVector" multiplicity="1" />
<elem name="stateErr" type="HPE.StateVector" multiplicity="1" />
<elem name="stateTruth" type="HPE.StateVector" multiplicity="1" />
<elem name="llaTruth" type="GeoSpatial.PositionECEF" multiplicity="1" />
<elem name="llaEst" type="GeoSpatial.PositionECEF" multiplicity="1" />
<elem name="enuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="enuEstVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="enuErrVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="veracity" type="float32" multiplicity="1" />
<elem name="floor" type="float32" multiplicity="1" />
<elem name="floorUncert" type="float32" multiplicity="1" />
<elem name="floorErr" type="float32" multiplicity="1" />
<elem name="floorLabel" type="string" multiplicity="1" />
<elem name="data" type="JSON" multiplicity="0..1" />
</struct>
<!--
*************************************
* Statistics Definition.
*************************************
-->
<struct name="Statistics" >
<comment>Calculated statistics for the associated the results.</comment>
<elem name="count" type="uint32" multiplicity="1" />
<elem name="cep50" type="float32" multiplicity="1" />
<elem name="cep68" type="float32" multiplicity="1" />
<elem name="cep95" type="float32" multiplicity="1" />
<elem name="cepmax" type="float32" multiplicity="1" />
<elem name="rmsuncert" type="float32" multiplicity="1" />
<elem name="rmserr" type="float32" multiplicity="1" />
<elem name="meanState" type="HPE.StateVector" multiplicity="1" />
<elem name="meanStateErr" type="HPE.StateVector" multiplicity="1" />
<elem name="meanEnuErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVel" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVelUncert" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanEnuVelErr" type="GeoSpatial.XYZVector" multiplicity="1" />
<elem name="meanFloor" type="float32" multiplicity="1" />
<elem name="rmsFloorUncert" type="float32" multiplicity="1" />
<elem name="rmsFloorErr" type="float32" multiplicity="1" />
</struct>
<!--
*************************************
* ResultSet Structure Definition.
*************************************
-->
<struct name="ResultSet" type="GeoSpatial.Object" rttkey="GeoSptila.ObjectType.IlpTestResultSet">
<comment>Specification for an ILP Test data result set.</comment>
<elem name="uuidData" multiplicity ="0..*" type="UUID" >
<comment>Zero or more UUIDs identifying the survey test data used in this result set.</comment>
</elem>
<elem name="records" type="ResultRecord" multiplicity="0..*">
<comment>The estimated position result records.</comment>
</elem>
<elem name="stats" type="Statistics" multiplicity="1">
<comment>Statistics for the result set.</comment>
</elem>
<elem name="confidence" type="float32" multiplicity="1" >
<comment>Confidence for the result records. Typically this will be .6872, but will report the confidence specified by the input.</comment>
</elem> />
</struct>
<!--
*************************************
* Results Structure Definition.
*************************************
-->
<struct name="Results" type="GeoSpatial.Object" rttkey="GeoSptila.ObjectType.IlpTestResults">
<comment>Specification for an ILP Test data result set.</comment>
<elem name="uuidData" multiplicity ="0..*" type="UUID" >
<comment>Zero or more UUIDs identifying the survey test data used in this result set.</comment>
</elem>
<elem name="startExecutionDate" type="datetime" multiplicity="1">
<comment>Date and time the test was executed.</comment>
</elem>
<elem name="durationExecution" type="uint32" multiplicity="1">
<tag name="unit" value="msec"/>
<comment>Duration of the execution time in milliseconds.</comment>
</elem>
<elem name="uriSource" type="string" multiplicity="1">
<comment>Source of results.</comment>
</elem>
</struct>
<!--
*******************************************************
Test Execution API
*******************************************************
-->
<interface name="Test">
<comment>Interface for submitting ILP Test Specifications for execution.</comment>
<operation name="Execute">
<comment>
Operation executes the provided specification.
</comment>
<input name="input" type="Tensor.InputBase" sid="0x1060">
<elem name="returnResults" multiplicity ="1" type="bool" default ="true">
<comment>Optional, determines if results should be returned to caller on completion. By default, this is true. For long processing sessions
the connection timeout may occur before results are returned. In that case check the published results.</comment>
</elem>
<elem name="saveResults" multiplicity ="1" type="bool" default ="false">
<comment>Optional, determines if processing results should be stored</comment>
</elem>
<elem name="publishResults" multiplicity ="1" type="bool" default ="false">
<comment>Optional, publishes the results for additional downstream processing.</comment>
</elem>
<elem name="spec" multiplicity="1" type="Specification">
<comment>The test specification to execute.</comment>
</elem>
</input>
<output name="output" type="Tensor.OutputBase" sid="0x1061">
<comment>Test Execution output. Note if not wanting results, the execute method will return early with a processing result code.</comment>
<elem name="results" multiplicity="0..1" type="Results">
<comment>The result test data set if the 'returnResults' option was selected on input.</comment>
</elem>
<elem name="dataSetsFiltered" multiplicity="0..*" type="DataSet">
<comment>The resultant requested filtered data sets if any.</comment>
</elem>
</output>
</operation>
</interface>
</namespace>
</specification>
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!