Common.xid.xml 3.69 KB
<?xml version="1.0" encoding="UTF-8" ?>

<!--
  Copyright (c) 2017, TeleCommunication Systems, Inc.,
  a wholly-owned subsidiary of Comtech Telecommunications Corp.
  and/or affiliates of TeleCommunication Systems, Inc.
  All rights reserved.
  TeleCommunication Systems, Inc. PROPRIETARY/CONFIDENTIAL.
  Use is subject to license terms included in the distribution.
-->

<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="Common.xid.xml">
    <title>Tensor Common Definitions</title>
    <comment></comment>
    <artifact></artifact>

    <import ref="https://xid.location.studio/Tensor/V1.1/Definitions.xid.xml" local="Definitions.xid.xml" />

    <namespace name="Tensor">
      <struct name="NameValue" >
        <comment>A string base name value pair entry.</comment>
        <elem name="name" type="Tensor.string" ord="64"/>
        <elem name="value" type="Tensor.string" ord="65"/>
      </struct>

      <enum name="ResultCode" type="Tensor.int8" default="undefined">
        <comment>General processing result codes.</comment>
        <literal name="success" value="1"/>
        <literal name="undefined" value="0"/>
        <literal name="failure" value="-1" />
        <literal name="busy" value="-2" />
        <literal name="processingError" value="-3"/>
        <literal name="parsingError" value="-4"/>
        <literal name="malformedRequest" value="-5"/>
        <literal name="encodingError" value="-6"/>
        
      </enum>

      <struct name="VoidType">
        <comment>Reserved type used in various translations to preserve translation. It has no purpose but as a placeholder. This is different from type "void" in Definitions.xid</comment>
        <elem name="reserved" type="Tensor.uint16" multiplicity="1" ord="64"/>
      </struct>     
      
      <enum name="WirelineFormat" type="Tensor.uint8" default="undefined">
          <comment>Enum defines the wireline data format of XID interactions.  These are defined to facilitate standard definitions within XID interactions independent of the 
          specific transport protocol or XID conduit.</comment>
          <literal name ="undefined" value = "0"/>
          <literal name ="raw" value = "1"/>
          <literal name ="base64" value = "2"/>
          <literal name ="hex" value = "3"/>          
      </enum>
      
      <enum name="ContentType" type="Tensor.uint8" default="undefined">
          <comment>Enum defines the content type of XID interactions.  These are defined to facilitate standard definitions within XID interactions independent of the 
          specific transport protocol or XID conduit.</comment>
          <literal name ="undefined" value = "0"/>
          <literal name ="dataobject" value = "1"/>
          <literal name ="xmf" value = "2"/>
          <literal name ="json" value = "3"/>          
      </enum>      
      
      <enum name="InteractionRole" type="Tensor.uint8" default="undefined">
          <comment>InteractionRole defines the role of the conduit in a XID interaction.
		    A Conduit port must adopt either the target or initiator role to preserve
		    interaction continuity and conventions.</comment>
          <literal name ="undefined" value = "0"/>
          <literal name ="target" value = "1"/>
          <literal name ="initiator" value = "2"/>
      </enum>      
  
    </namespace>
</specification>