tml:clusterDesc 

An empty clusterdesc tag in a data stream indicates that this cluster is no longer contained in the data stream.

Element Information

Model

tml:description{0,1} , tml:idMapping{0,1} , tml:clusterProperties{0,1} , tml:binHeaderEncode{0,1} , tml:timeTag{0,1} , tml:dataUnitEncoding* , tml:numCfInCluster{0,1} , tml:transSeq*
Children: tml:binHeaderEncode, tml:clusterProperties, tml:dataUnitEncoding, tml:description, tml:idMapping, tml:numCfInCluster, tml:timeTag, tml:transSeq

Attributes

QName Type Fixed Default Use Inheritable Annotation
FGIsourceOpen xsd:NMTOKENS optional 
Non-US classification portion marking for foreign government
information in a document portion. Use this attribute to record
a source country when the intent is to post the document to a
shared space with the source identified.
FGIsourceProtected xsd:NMTOKENS optional 
Non-US classification portion marking for foreign government
information in a document portion. Use this attribute to record
a source country when the intent is to filter out the identity of
the source prior to posting the document to a shared space.
SARIdentifier xsd:NMTOKENS optional 
Authorized Special Access Required program digraph(s) or
trigraph(s) preceded by "SAR-". Either (a) a single digraph or
trigraph or (b) a space-delimited list of digraphs or trigraphs.
Example: "SAR-ABC SAR-DEF ..."
SCIcontrols xsd:NMTOKENS optional 
Authorized abbreviation(s) of SCI control system(s). Either
(a) a single abbreviation or (b) a space-delimited list of
abbreviations in the order prescribed in the CAPCO Register.
classification ClassificationType optional
classificationReason xsd:string optional 
A text string containing one or more paragraph numbers, 1.4(a)
through 1.4(h), taken from E.O. 12958, as amended. Enter the
paragraph references as they should appear in a
classification/declassification block.
classifiedBy xsd:string optional 
Use as specified by E.O. 12958.
dateOfExemptedSource xsd:date optional 
A specific date, in the format YYYY-MM-DD. Used in conjunction with
attribute "typeOfExemptedSource." If there are multiple exempted
sources, specify the date of the exempted
source that has the most recent date.
declassDate xsd:date optional 
A specific date, in the format YYYY-MM-DD, at which the applicable
information is automatically declassified.
declassEvent xsd:string optional 
A textual description of an event that triggers declassification.
declassException xsd:NMTOKENS optional 
One or more of the exceptions to 25-year declassification:
specify "25X1-human", "25X1", "25X2", ..., "25X9". If more than
one exception applies, use a space-delimited list. If "25X1-human"
applies, it should be first in a list.
declassManualReview xsd:boolean optional 
A true/false indication that manual review is required for
declassification. Use this attribute to force the appearance of
"//MR" in the header and footer marking titles. Use this attribute
ONLY when it is necessary to override the business logic applied to
classification and control markings in the document to determine
whether manual review is required.
derivedFrom xsd:string optional 
A text string containing (a) the title and date of a specific source
document, or (b) the title and date of an organization classification
guide, or (c) the literal string "Multiple Sources".
disseminationControls xsd:NMTOKENS optional 
Authorized dissemination control portion mark abbreviation(s).
Either (a) a single abbreviation or (b) a space-delimited list
of abbreviations in the order shown in the CAPCO Register.
Exception: For the "REL" abbreviation, omit the country code
trigraph(s) and instead place the trigraph(s) in the
"releasableTo" attribute value.
name xs:string optional 
short descriptive name of element
nonICmarkings xsd:NMTOKENS optional 
Authorized non-IC portion marking abbreviation(s) from the CAPCO
Register. Either (a) a single non-IC abbreviated marking or
(b) a space-delimited list of abbreviations in the order shown
in the CAPCO Register.
ownerProducer xsd:NMTOKENS optional 
ISO 3166-1 trigraph(s) of the owner or producer country(ies) and/or
CAPCO-specified tetragraphs of international organizations.
Either (a) a single trigraph or tetragraph or (b) a space-delimited
list of trigraphs followed by tetragraphs. Trigraphs must be in
alphabetical order and tetragraphs must be in alphabetical order.
releasableTo xsd:NMTOKENS optional 
ISO 3166-1 trigraphic codes of countries to which the associated
content can be released. Include "USA" in all instances. Use a space-
delimited list with "USA" first, followed by the other trigraph(s)
in alphabetical order.
typeOfExemptedSource xsd:NMTOKENS optional 
One or more tokens indicating that a source that is exempted from
automatic declassification applies. Specify "OADR", "X1", "X2", ...,
"X8". If more than one applies, use a space-delimited list.
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

Element tml:SystemType/tml:clusterDescriptions

Source 

<xs:element name="clusterDesc">
  <xs:annotation>
    <xs:documentation>An empty clusterdesc tag in a data stream indicates that this cluster is no longer contained in the data stream.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence minOccurs="0">
      <xs:element name="description" type="tml:BindType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>description of the data cluster</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="idMapping" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="tapPointUidRef" type="tml:BindType" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>dataUidRef of the tap point in the system to which this cluster corresponds. UID of the transducer, process input process output, or connection node from which or to which this cluster relates. This is the UID used in the data header (i.e. reference attribute in data start tag). Is some cases a data in a single cluster may come from multiple dataUid tap points.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="localID" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>short ID used in the data header (i.e. ref attribute in data start tag)</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="clusterProperties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="direction" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed Values: fromSystem, toSystem. default fromSystem</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element ref="tml:complexity" minOccurs="0"/>
            <xs:element name="clusterType" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: binary, packedXML. verboseXML. default binary</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="clusterSize" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Integer number of bytes in Cluster</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <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>
      <xs:element name="timeTag" minOccurs="0">
        <xs:annotation>
          <xs:documentation>describes what time tag is used for the cluster. Useful when parent systems normalize clocks from child components. This element also describes how accurately the sysClk value is applied to the cluster start instant. This is different from the accuracy of the system clock.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="sysClkUidRef" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>if clk is used in the start tag and multiple clocks are used in a system. Default is the first parent system clock</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element ref="tml:accuracy" minOccurs="0"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="dataUnitEncoding" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>This unit describes the encoding of the dataUnit identified in the dataUnitUidRef child element. Some clusters which represent only an event from a source or a trigger are empty and may not contain any dataUnits.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="dataUnitUidRef" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>UID of the dataUnit from the logical structure.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="dataType" type="tml:BindType" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values: text, number, binBlob. Default is text.</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</xs:documentation>
                    </xs:annotation>
                    <xs:element name="numBits" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>default 8</xs:documentation>
                      </xs:annotation>
                    </xs:element>
                    <xs:element name="numSigBits" type="tml:BindType" minOccurs="0">
                      <xs:annotation>
                        <xs:documentation>default</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. Default 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>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, complex, bcd. default utf8. When clusterType is not binary only utf8 is allowed in cluster. All types are allowed when clusterType is binary. Complex values are exchanged as two phenomenon (mag and phase or real and imaginary components) or as a single complex number.</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:element name="numCfInCluster" type="tml:BindType" minOccurs="0">
        <xs:annotation>
          <xs:documentation>number of characteristic frames in a cluster or the number of clusters which comprise a large characteristic frame. default = 1. example: 2 means 2 CF per cluster, -2 means 2 clusters per CF. Allowed values: signed integer. zero not allowed.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="transSeq" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>This is the order in which data is sent in the cluster or CF (whichever is larger) relative to the logical data structure. The order of structure components are listed from lowest freq to highest frequency order. If transport sequence is blank then the sequence is the same as the logical order (sequence) for that structure component.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="seqOfThisDataStruct" type="tml:BindType" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>Sequence of (in this element - seqOfThisDataStruct) in the data structure identified in the next element (inThisDataStruct). seqOfBitsInUnit, seqOfUnitsInSets, seqOfSetsInCf, seqOfCfInClust. Identify the dataStructComponent in this element by dataUidRef. dataUid of the cluster is "cluster"</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="inThisDataStruct" type="tml:BindType" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>Sequence of the data structure components identified in the previous element (seqOfThisDataStruct) in the data structure identified in this element (inThisDataStruct). seqOfBitsInUnit, seqOfUnitsInSets, seqOfSetsInCf, seqOfCfInClust. Identify the dataStructComponent in this element by dataUidRef. dataUid of the cluster is "cluster"</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="sequence" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Allowed values; The sequence shall contain a string of value separated by a comma. Each value can be a positive integer or a range. ranges shall be indicated by two integer numbers separated by three sequential decimal points (....) to indicate a run from the first number to the second</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:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attributeGroup ref="tml:uid_uidRef"/>
    <xs:attributeGroup ref="ism:SecurityAttributesOptionGroup"/>
  </xs:complexType>
</xs:element>

Sample