Class CoT

Convert to and from an XML CoT message

Param: cot

A string/buffer containing the XML representation or the xml-js object tree

Constructors

constructor

new CoT(
    cot: {
        event: {
            _attributes: {
                access?: string;
                how?: string;
                opex?: string;
                qos?: string;
                stale: string;
                start: string;
                time: string;
                type: string;
                uid: string;
                version: string;
            };
            detail?: {
                __chat?: {
                    _attributes: {
                        chatroom: string;
                        groupOwner?: string;
                        id: string;
                        messageId?: string;
                        parent?: string;
                        senderCallsign: string;
                    };
                    chatgrp: any;
                };
                __forcedelete?: {};
                __geofence?: {
                    _attributes: {
                        boundingSphere?: number;
                        elevationMonitored?: string;
                        maxElevation?: string;
                        minElevation?: string;
                        monitor?: string;
                        tracking?: string;
                        trigger?: string;
                    };
                };
                __group?: { _attributes?: { name: string; role: string } };
                __milsym?: {
                    _attributes: { id: string };
                    unitmodifier?:
                        | { _attributes: { code: string }; _text?: string }
                        | { _attributes: { code: string }; _text?: string }[];
                };
                __routeinfo?: {
                    __navcues: {
                        __navcue: | {
                            _attributes: { id: ...; text: ...; voice: ... };
                            trigger: { _attributes: ... };
                        }[]
                        | {
                            _attributes: { id: string; text: string; voice: string };
                            trigger: { _attributes: { mode: ...; value: ... } };
                        };
                    };
                };
                __video?: {
                    _attributes?: {
                        sensor?: string;
                        spi?: string;
                        uid?: string;
                        url?: string;
                    };
                    ConnectionEntry?: {
                        _attributes: {
                            address: string;
                            alias?: string;
                            bufferTime?: number;
                            ignoreEmbeddedKLV?: boolean;
                            networkTimeout?: number;
                            path?: string;
                            port?: number;
                            protocol?: string;
                            roverPort?: number;
                            rtspReliable?: number;
                            uid: string;
                        };
                    };
                };
                "_flow-tags_"?: any;
                ackrequest?: {
                    _attributes: { ackrequested: boolean; tag: string; uid: string };
                };
                archive?: | { _attributes?: { value?: string } }
                | { _attributes?: { value?: string } }[];
                attachment_list?: { _attributes: { hashes: string } };
                bearing?: { _attributes: { value: number } };
                bearingUnits?: { _attributes: { value: number } };
                color?: { _attributes?: { argb?: number; value?: number } };
                contact?: {
                    _attributes: {
                        callsign?: string;
                        endpoint?: string;
                        name?: string;
                        phone?: string;
                    };
                };
                creator?: {
                    _attributes: {
                        callsign: string;
                        time: string;
                        type: string;
                        uid: string;
                    };
                };
                fileshare?: {
                    _attributes: {
                        filename: string;
                        name: string;
                        senderCallsign: string;
                        senderUid: string;
                        senderUrl: string;
                        sha256: string;
                        sizeInBytes: number;
                    };
                };
                fillColor?: { _attributes?: { value?: number } };
                inclination?: { _attributes: { value: number } };
                labels_on?: { _attributes?: { value?: boolean } };
                link?:
                    | {
                        _attributes: {
                            callsign?: string;
                            mime?: string;
                            parent_callsign?: string;
                            point?: string;
                            production_time?: string;
                            relation?: string;
                            remarks?: string;
                            type?: string;
                            uid?: string;
                            url?: string;
                        };
                    }
                    | {
                        _attributes: {
                            callsign?: string;
                            mime?: string;
                            parent_callsign?: string;
                            point?: string;
                            production_time?: string;
                            relation?: string;
                            remarks?: string;
                            type?: string;
                            uid?: string;
                            url?: string;
                        };
                    }[];
                link_attr?: {
                    _attributes: {
                        color?: number;
                        direction?: "Infil"
                        | "Exfil";
                        method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
                        order: "Ascending Check Points" | "Descending Check Points";
                        planningmethod?: "Infil" | "Exfil";
                        prefix: string;
                        routetype: "Primary" | "Secondary";
                        stroke?: string;
                        style?: string;
                        type?: string;
                    };
                };
                marti?: {
                    _attributes?: {};
                    dest?: | {
                        _attributes: {
                            after?: string;
                            callsign?: string;
                            group?: string;
                            mission?: string;
                            "mission-guid"?: string;
                            path?: string;
                            uid?: string;
                        };
                    }
                    | {
                        _attributes: {
                            after?: (...)
                            | (...);
                            callsign?: (...) | (...);
                            group?: (...) | (...);
                            mission?: (...) | (...);
                            "mission-guid"?: (...) | (...);
                            path?: (...) | (...);
                            uid?: (...) | (...);
                        };
                    }[];
                };
                mission?: {
                    _attributes?: {
                        authorUid?: string;
                        guid?: string;
                        name?: string;
                        tool?: string;
                        type?: string;
                    };
                    MissionChanges?: {
                        MissionChange: | {
                            contentUid: { _text: ... };
                            creatorUid: { _text?: ... };
                            details: { _attributes: ...; location?: ... };
                            isFederatedChange: { _text: ... };
                            missionName: { _text: ... };
                            timestamp: { _text: ... };
                            type: { _text: ... };
                        }
                        | {
                            contentUid: ...;
                            creatorUid: ...;
                            details: ...;
                            isFederatedChange: ...;
                            missionName: ...;
                            timestamp: ...;
                            type: ...;
                        }[];
                    };
                    missionLayer?: {
                        name?: { _text: string };
                        parentUid?: { _text: string };
                        type?: { _text: string };
                        uid?: { _text: string };
                    };
                };
                northRef?: { _attributes: { value: number } };
                precisionlocation?: {
                    _attributes: { altsrc?: string; geopointsrc?: string };
                };
                range?: { _attributes: { value: number } };
                rangeUnits?: { _attributes: { value: number } };
                remarks?: {
                    _attributes?: { source?: string; time?: string; to?: string };
                    _text?: string;
                };
                sensor?: {
                    _attributes: {
                        azimuth?: number;
                        displayMagneticReference?: number;
                        elevation?: number;
                        fov?: number;
                        fovAlpha?: number;
                        fovBlue?: number;
                        fovGreen?: number;
                        fovRed?: number;
                        hideFov?: boolean;
                        model?: string;
                        north?: number;
                        range?: number;
                        rangeLines?: number;
                        rangeLineStrokeColor?: number;
                        rangeLineStrokeWeight?: number;
                        roll?: number;
                        strokeColor?: number;
                        strokeWeight?: number;
                        type?: string;
                        version?: string;
                        vfov?: number;
                    };
                };
                shape?: {
                    ellipse?: {
                        _attributes: { angle: number; major: number; minor: number };
                    };
                    polyline?: {
                        _attributes?: {
                            closed?: (...)
                            | (...)
                            | (...);
                            color?: (...) | (...);
                            fillColor?: (...) | (...);
                        };
                        vertex?: | { _attributes: { lat: ...; lon: ... } }
                        | { _attributes: ... }[];
                    };
                };
                status?: { _attributes: { battery?: string; readiness?: string } };
                strokeColor?: { _attributes?: { value?: number } };
                strokeStyle?: { _attributes?: { value?: string } };
                strokeWeight?: { _attributes?: { value?: number } };
                TakControl?: {
                    TakProtocolSupport?: { _attributes?: { version?: (...) | (...) } };
                    TakServerVersionInfo?: {
                        _attributes?: { serverVersion?: (...) | (...) };
                    };
                };
                takv?: {
                    _attributes: {
                        device?: string;
                        os?: string;
                        platform?: string;
                        version?: string;
                    };
                };
                tog?: { _attributes?: { enabled?: string } };
                track?: {
                    _attributes?: {
                        course?: string;
                        eCourse?: string;
                        eSlope?: string;
                        eSpeed?: string;
                        slope?: string;
                        speed?: string;
                    };
                };
                uid?: { _attributes: { Droid: string } };
                usericon?: { _attributes: { iconsetpath: string } };
            };
            point: {
                _attributes: {
                    ce: string
                    | number;
                    hae: number;
                    lat: number;
                    le: string | number;
                    lon: number;
                };
            };
        };
    },
    opts?: CoTOptions,
): CoT
Parameters
- cot: {
      event: {
          _attributes: {
              access?: string;
              how?: string;
              opex?: string;
              qos?: string;
              stale: string;
              start: string;
              time: string;
              type: string;
              uid: string;
              version: string;
          };
          detail?: {
              __chat?: {
                  _attributes: {
                      chatroom: string;
                      groupOwner?: string;
                      id: string;
                      messageId?: string;
                      parent?: string;
                      senderCallsign: string;
                  };
                  chatgrp: any;
              };
              __forcedelete?: {};
              __geofence?: {
                  _attributes: {
                      boundingSphere?: number;
                      elevationMonitored?: string;
                      maxElevation?: string;
                      minElevation?: string;
                      monitor?: string;
                      tracking?: string;
                      trigger?: string;
                  };
              };
              __group?: { _attributes?: { name: string; role: string } };
              __milsym?: {
                  _attributes: { id: string };
                  unitmodifier?:
                      | { _attributes: { code: string }; _text?: string }
                      | { _attributes: { code: string }; _text?: string }[];
              };
              __routeinfo?: {
                  __navcues: {
                      __navcue: | {
                          _attributes: { id: ...; text: ...; voice: ... };
                          trigger: { _attributes: ... };
                      }[]
                      | {
                          _attributes: { id: string; text: string; voice: string };
                          trigger: { _attributes: { mode: ...; value: ... } };
                      };
                  };
              };
              __video?: {
                  _attributes?: {
                      sensor?: string;
                      spi?: string;
                      uid?: string;
                      url?: string;
                  };
                  ConnectionEntry?: {
                      _attributes: {
                          address: string;
                          alias?: string;
                          bufferTime?: number;
                          ignoreEmbeddedKLV?: boolean;
                          networkTimeout?: number;
                          path?: string;
                          port?: number;
                          protocol?: string;
                          roverPort?: number;
                          rtspReliable?: number;
                          uid: string;
                      };
                  };
              };
              "_flow-tags_"?: any;
              ackrequest?: {
                  _attributes: { ackrequested: boolean; tag: string; uid: string };
              };
              archive?: | { _attributes?: { value?: string } }
              | { _attributes?: { value?: string } }[];
              attachment_list?: { _attributes: { hashes: string } };
              bearing?: { _attributes: { value: number } };
              bearingUnits?: { _attributes: { value: number } };
              color?: { _attributes?: { argb?: number; value?: number } };
              contact?: {
                  _attributes: {
                      callsign?: string;
                      endpoint?: string;
                      name?: string;
                      phone?: string;
                  };
              };
              creator?: {
                  _attributes: {
                      callsign: string;
                      time: string;
                      type: string;
                      uid: string;
                  };
              };
              fileshare?: {
                  _attributes: {
                      filename: string;
                      name: string;
                      senderCallsign: string;
                      senderUid: string;
                      senderUrl: string;
                      sha256: string;
                      sizeInBytes: number;
                  };
              };
              fillColor?: { _attributes?: { value?: number } };
              inclination?: { _attributes: { value: number } };
              labels_on?: { _attributes?: { value?: boolean } };
              link?:
                  | {
                      _attributes: {
                          callsign?: string;
                          mime?: string;
                          parent_callsign?: string;
                          point?: string;
                          production_time?: string;
                          relation?: string;
                          remarks?: string;
                          type?: string;
                          uid?: string;
                          url?: string;
                      };
                  }
                  | {
                      _attributes: {
                          callsign?: string;
                          mime?: string;
                          parent_callsign?: string;
                          point?: string;
                          production_time?: string;
                          relation?: string;
                          remarks?: string;
                          type?: string;
                          uid?: string;
                          url?: string;
                      };
                  }[];
              link_attr?: {
                  _attributes: {
                      color?: number;
                      direction?: "Infil"
                      | "Exfil";
                      method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
                      order: "Ascending Check Points" | "Descending Check Points";
                      planningmethod?: "Infil" | "Exfil";
                      prefix: string;
                      routetype: "Primary" | "Secondary";
                      stroke?: string;
                      style?: string;
                      type?: string;
                  };
              };
              marti?: {
                  _attributes?: {};
                  dest?: | {
                      _attributes: {
                          after?: string;
                          callsign?: string;
                          group?: string;
                          mission?: string;
                          "mission-guid"?: string;
                          path?: string;
                          uid?: string;
                      };
                  }
                  | {
                      _attributes: {
                          after?: (...)
                          | (...);
                          callsign?: (...) | (...);
                          group?: (...) | (...);
                          mission?: (...) | (...);
                          "mission-guid"?: (...) | (...);
                          path?: (...) | (...);
                          uid?: (...) | (...);
                      };
                  }[];
              };
              mission?: {
                  _attributes?: {
                      authorUid?: string;
                      guid?: string;
                      name?: string;
                      tool?: string;
                      type?: string;
                  };
                  MissionChanges?: {
                      MissionChange: | {
                          contentUid: { _text: ... };
                          creatorUid: { _text?: ... };
                          details: { _attributes: ...; location?: ... };
                          isFederatedChange: { _text: ... };
                          missionName: { _text: ... };
                          timestamp: { _text: ... };
                          type: { _text: ... };
                      }
                      | {
                          contentUid: ...;
                          creatorUid: ...;
                          details: ...;
                          isFederatedChange: ...;
                          missionName: ...;
                          timestamp: ...;
                          type: ...;
                      }[];
                  };
                  missionLayer?: {
                      name?: { _text: string };
                      parentUid?: { _text: string };
                      type?: { _text: string };
                      uid?: { _text: string };
                  };
              };
              northRef?: { _attributes: { value: number } };
              precisionlocation?: {
                  _attributes: { altsrc?: string; geopointsrc?: string };
              };
              range?: { _attributes: { value: number } };
              rangeUnits?: { _attributes: { value: number } };
              remarks?: {
                  _attributes?: { source?: string; time?: string; to?: string };
                  _text?: string;
              };
              sensor?: {
                  _attributes: {
                      azimuth?: number;
                      displayMagneticReference?: number;
                      elevation?: number;
                      fov?: number;
                      fovAlpha?: number;
                      fovBlue?: number;
                      fovGreen?: number;
                      fovRed?: number;
                      hideFov?: boolean;
                      model?: string;
                      north?: number;
                      range?: number;
                      rangeLines?: number;
                      rangeLineStrokeColor?: number;
                      rangeLineStrokeWeight?: number;
                      roll?: number;
                      strokeColor?: number;
                      strokeWeight?: number;
                      type?: string;
                      version?: string;
                      vfov?: number;
                  };
              };
              shape?: {
                  ellipse?: {
                      _attributes: { angle: number; major: number; minor: number };
                  };
                  polyline?: {
                      _attributes?: {
                          closed?: (...)
                          | (...)
                          | (...);
                          color?: (...) | (...);
                          fillColor?: (...) | (...);
                      };
                      vertex?: | { _attributes: { lat: ...; lon: ... } }
                      | { _attributes: ... }[];
                  };
              };
              status?: { _attributes: { battery?: string; readiness?: string } };
              strokeColor?: { _attributes?: { value?: number } };
              strokeStyle?: { _attributes?: { value?: string } };
              strokeWeight?: { _attributes?: { value?: number } };
              TakControl?: {
                  TakProtocolSupport?: { _attributes?: { version?: (...) | (...) } };
                  TakServerVersionInfo?: {
                      _attributes?: { serverVersion?: (...) | (...) };
                  };
              };
              takv?: {
                  _attributes: {
                      device?: string;
                      os?: string;
                      platform?: string;
                      version?: string;
                  };
              };
              tog?: { _attributes?: { enabled?: string } };
              track?: {
                  _attributes?: {
                      course?: string;
                      eCourse?: string;
                      eSlope?: string;
                      eSpeed?: string;
                      slope?: string;
                      speed?: string;
                  };
              };
              uid?: { _attributes: { Droid: string } };
              usericon?: { _attributes: { iconsetpath: string } };
          };
          point: {
              _attributes: {
                  ce: string
                  | number;
                  hae: number;
                  lat: number;
                  le: string | number;
                  lon: number;
              };
          };
      };
  }
- opts: CoTOptions = {}
Returns CoT
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:50

Properties

metadata

metadata: Record<string, unknown>

path

path: string

raw

raw: {
    event: {
        _attributes: {
            access?: string;
            how?: string;
            opex?: string;
            qos?: string;
            stale: string;
            start: string;
            time: string;
            type: string;
            uid: string;
            version: string;
        };
        detail?: {
            __chat?: {
                _attributes: {
                    chatroom: string;
                    groupOwner?: string;
                    id: string;
                    messageId?: string;
                    parent?: string;
                    senderCallsign: string;
                };
                chatgrp: any;
            };
            __forcedelete?: {};
            __geofence?: {
                _attributes: {
                    boundingSphere?: number;
                    elevationMonitored?: string;
                    maxElevation?: string;
                    minElevation?: string;
                    monitor?: string;
                    tracking?: string;
                    trigger?: string;
                };
            };
            __group?: { _attributes?: { name: string; role: string } };
            __milsym?: {
                _attributes: { id: string };
                unitmodifier?:
                    | { _attributes: { code: string }; _text?: string }
                    | { _attributes: { code: string }; _text?: string }[];
            };
            __routeinfo?: {
                __navcues: {
                    __navcue: | {
                        _attributes: { id: ...; text: ...; voice: ... };
                        trigger: { _attributes: ... };
                    }[]
                    | {
                        _attributes: { id: string; text: string; voice: string };
                        trigger: { _attributes: { mode: ...; value: ... } };
                    };
                };
            };
            __video?: {
                _attributes?: {
                    sensor?: string;
                    spi?: string;
                    uid?: string;
                    url?: string;
                };
                ConnectionEntry?: {
                    _attributes: {
                        address: string;
                        alias?: string;
                        bufferTime?: number;
                        ignoreEmbeddedKLV?: boolean;
                        networkTimeout?: number;
                        path?: string;
                        port?: number;
                        protocol?: string;
                        roverPort?: number;
                        rtspReliable?: number;
                        uid: string;
                    };
                };
            };
            "_flow-tags_"?: any;
            ackrequest?: {
                _attributes: { ackrequested: boolean; tag: string; uid: string };
            };
            archive?: | { _attributes?: { value?: string } }
            | { _attributes?: { value?: string } }[];
            attachment_list?: { _attributes: { hashes: string } };
            bearing?: { _attributes: { value: number } };
            bearingUnits?: { _attributes: { value: number } };
            color?: { _attributes?: { argb?: number; value?: number } };
            contact?: {
                _attributes: {
                    callsign?: string;
                    endpoint?: string;
                    name?: string;
                    phone?: string;
                };
            };
            creator?: {
                _attributes: {
                    callsign: string;
                    time: string;
                    type: string;
                    uid: string;
                };
            };
            fileshare?: {
                _attributes: {
                    filename: string;
                    name: string;
                    senderCallsign: string;
                    senderUid: string;
                    senderUrl: string;
                    sha256: string;
                    sizeInBytes: number;
                };
            };
            fillColor?: { _attributes?: { value?: number } };
            inclination?: { _attributes: { value: number } };
            labels_on?: { _attributes?: { value?: boolean } };
            link?:
                | {
                    _attributes: {
                        callsign?: string;
                        mime?: string;
                        parent_callsign?: string;
                        point?: string;
                        production_time?: string;
                        relation?: string;
                        remarks?: string;
                        type?: string;
                        uid?: string;
                        url?: string;
                    };
                }
                | {
                    _attributes: {
                        callsign?: string;
                        mime?: string;
                        parent_callsign?: string;
                        point?: string;
                        production_time?: string;
                        relation?: string;
                        remarks?: string;
                        type?: string;
                        uid?: string;
                        url?: string;
                    };
                }[];
            link_attr?: {
                _attributes: {
                    color?: number;
                    direction?: "Infil"
                    | "Exfil";
                    method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
                    order: "Ascending Check Points" | "Descending Check Points";
                    planningmethod?: "Infil" | "Exfil";
                    prefix: string;
                    routetype: "Primary" | "Secondary";
                    stroke?: string;
                    style?: string;
                    type?: string;
                };
            };
            marti?: {
                _attributes?: {};
                dest?: | {
                    _attributes: {
                        after?: string;
                        callsign?: string;
                        group?: string;
                        mission?: string;
                        "mission-guid"?: string;
                        path?: string;
                        uid?: string;
                    };
                }
                | {
                    _attributes: {
                        after?: (...)
                        | (...);
                        callsign?: (...) | (...);
                        group?: (...) | (...);
                        mission?: (...) | (...);
                        "mission-guid"?: (...) | (...);
                        path?: (...) | (...);
                        uid?: (...) | (...);
                    };
                }[];
            };
            mission?: {
                _attributes?: {
                    authorUid?: string;
                    guid?: string;
                    name?: string;
                    tool?: string;
                    type?: string;
                };
                MissionChanges?: {
                    MissionChange: | {
                        contentUid: { _text: ... };
                        creatorUid: { _text?: ... };
                        details: { _attributes: ...; location?: ... };
                        isFederatedChange: { _text: ... };
                        missionName: { _text: ... };
                        timestamp: { _text: ... };
                        type: { _text: ... };
                    }
                    | {
                        contentUid: ...;
                        creatorUid: ...;
                        details: ...;
                        isFederatedChange: ...;
                        missionName: ...;
                        timestamp: ...;
                        type: ...;
                    }[];
                };
                missionLayer?: {
                    name?: { _text: string };
                    parentUid?: { _text: string };
                    type?: { _text: string };
                    uid?: { _text: string };
                };
            };
            northRef?: { _attributes: { value: number } };
            precisionlocation?: {
                _attributes: { altsrc?: string; geopointsrc?: string };
            };
            range?: { _attributes: { value: number } };
            rangeUnits?: { _attributes: { value: number } };
            remarks?: {
                _attributes?: { source?: string; time?: string; to?: string };
                _text?: string;
            };
            sensor?: {
                _attributes: {
                    azimuth?: number;
                    displayMagneticReference?: number;
                    elevation?: number;
                    fov?: number;
                    fovAlpha?: number;
                    fovBlue?: number;
                    fovGreen?: number;
                    fovRed?: number;
                    hideFov?: boolean;
                    model?: string;
                    north?: number;
                    range?: number;
                    rangeLines?: number;
                    rangeLineStrokeColor?: number;
                    rangeLineStrokeWeight?: number;
                    roll?: number;
                    strokeColor?: number;
                    strokeWeight?: number;
                    type?: string;
                    version?: string;
                    vfov?: number;
                };
            };
            shape?: {
                ellipse?: {
                    _attributes: { angle: number; major: number; minor: number };
                };
                polyline?: {
                    _attributes?: {
                        closed?: (...)
                        | (...)
                        | (...);
                        color?: (...) | (...);
                        fillColor?: (...) | (...);
                    };
                    vertex?: | { _attributes: { lat: ...; lon: ... } }
                    | { _attributes: ... }[];
                };
            };
            status?: { _attributes: { battery?: string; readiness?: string } };
            strokeColor?: { _attributes?: { value?: number } };
            strokeStyle?: { _attributes?: { value?: string } };
            strokeWeight?: { _attributes?: { value?: number } };
            TakControl?: {
                TakProtocolSupport?: { _attributes?: { version?: (...) | (...) } };
                TakServerVersionInfo?: {
                    _attributes?: { serverVersion?: (...) | (...) };
                };
            };
            takv?: {
                _attributes: {
                    device?: string;
                    os?: string;
                    platform?: string;
                    version?: string;
                };
            };
            tog?: { _attributes?: { enabled?: string } };
            track?: {
                _attributes?: {
                    course?: string;
                    eCourse?: string;
                    eSlope?: string;
                    eSpeed?: string;
                    slope?: string;
                    speed?: string;
                };
            };
            uid?: { _attributes: { Droid: string } };
            usericon?: { _attributes: { iconsetpath: string } };
        };
        point: {
            _attributes: {
                ce: string
                | number;
                hae: number;
                lat: number;
                le: string | number;
                lon: number;
            };
        };
    };
}

Raw XML-JS representation of CoT

Methods

addDest

addDest(
    dest: {
        after?: string;
        callsign?: string;
        group?: string;
        mission?: string;
        "mission-guid"?: string;
        path?: string;
        uid?: string;
    },
): CoT
Add a given Dest tag to a CoT
Parameters
- dest: {
      after?: string;
      callsign?: string;
      group?: string;
      mission?: string;
      "mission-guid"?: string;
      path?: string;
      uid?: string;
  }
Returns CoT
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:149

addLink

addLink(
    link: {
        callsign?: string;
        mime?: string;
        parent_callsign?: string;
        point?: string;
        production_time?: string;
        relation?: string;
        remarks?: string;
        type?: string;
        uid?: string;
        url?: string;
    },
): CoT
Parameters
- link: {
      callsign?: string;
      mime?: string;
      parent_callsign?: string;
      point?: string;
      production_time?: string;
      relation?: string;
      remarks?: string;
      type?: string;
      uid?: string;
      url?: string;
  }
Returns CoT
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:279

addVideo

addVideo(
    video: { sensor?: string; spi?: string; uid?: string; url?: string },
    connection?: {
        address: string;
        alias?: string;
        bufferTime?: number;
        ignoreEmbeddedKLV?: boolean;
        networkTimeout?: number;
        path?: string;
        port?: number;
        protocol?: string;
        roverPort?: number;
        rtspReliable?: number;
        uid: string;
    },
): CoT
Parameters
- video: { sensor?: string; spi?: string; uid?: string; url?: string }
- Optionalconnection: {
      address: string;
      alias?: string;
      bufferTime?: number;
      ignoreEmbeddedKLV?: boolean;
      networkTimeout?: number;
      path?: string;
      port?: number;
      protocol?: string;
      roverPort?: number;
      rtspReliable?: number;
      uid: string;
  }
Returns CoT
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:168

archived

archived(archived?: boolean): boolean
Returns or sets the Archived State of the CoT
Parameters
- Optionalarchived: boolean
Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:105

callsign

callsign(callsign?: string): string
Returns or sets the Callsign of the CoT
Parameters
- Optionalcallsign: string
  Optional Callsign to set
Returns string
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:122

creator

creator(
    creator?: {
        callsign: string;
        time: undefined | string | Date;
        type: string;
        uid: string;
    },
): undefined
| { callsign: string; time: string; type: string; uid: string }
Parameters
- Optionalcreator: { callsign: string; time: undefined | string | Date; type: string; uid: string }
Returns undefined | { callsign: string; time: string; type: string; uid: string }
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:245

detail

detail(): {
    __chat?: {
        _attributes: {
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        chatgrp: any;
    };
    __forcedelete?: {};
    __geofence?: {
        _attributes: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
    };
    __group?: { _attributes?: { name: string; role: string } };
    __milsym?: {
        _attributes: { id: string };
        unitmodifier?:
            | { _attributes: { code: string }; _text?: string }
            | { _attributes: { code: string }; _text?: string }[];
    };
    __routeinfo?: {
        __navcues: {
            __navcue: | {
                _attributes: { id: string; text: string; voice: string };
                trigger: { _attributes: { mode: string; value: string } };
            }[]
            | {
                _attributes: { id: string; text: string; voice: string };
                trigger: { _attributes: { mode: string; value: string } };
            };
        };
    };
    __video?: {
        _attributes?: {
            sensor?: string;
            spi?: string;
            uid?: string;
            url?: string;
        };
        ConnectionEntry?: {
            _attributes: {
                address: string;
                alias?: string;
                bufferTime?: number;
                ignoreEmbeddedKLV?: boolean;
                networkTimeout?: number;
                path?: string;
                port?: number;
                protocol?: string;
                roverPort?: number;
                rtspReliable?: number;
                uid: string;
            };
        };
    };
    "_flow-tags_"?: any;
    ackrequest?: {
        _attributes: { ackrequested: boolean; tag: string; uid: string };
    };
    archive?: | { _attributes?: { value?: string } }
    | { _attributes?: { value?: string } }[];
    attachment_list?: { _attributes: { hashes: string } };
    bearing?: { _attributes: { value: number } };
    bearingUnits?: { _attributes: { value: number } };
    color?: { _attributes?: { argb?: number; value?: number } };
    contact?: {
        _attributes: {
            callsign?: string;
            endpoint?: string;
            name?: string;
            phone?: string;
        };
    };
    creator?: {
        _attributes: {
            callsign: string;
            time: string;
            type: string;
            uid: string;
        };
    };
    fileshare?: {
        _attributes: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
    };
    fillColor?: { _attributes?: { value?: number } };
    inclination?: { _attributes: { value: number } };
    labels_on?: { _attributes?: { value?: boolean } };
    link?:
        | {
            _attributes: {
                callsign?: string;
                mime?: string;
                parent_callsign?: string;
                point?: string;
                production_time?: string;
                relation?: string;
                remarks?: string;
                type?: string;
                uid?: string;
                url?: string;
            };
        }
        | {
            _attributes: {
                callsign?: string;
                mime?: string;
                parent_callsign?: string;
                point?: string;
                production_time?: string;
                relation?: string;
                remarks?: string;
                type?: string;
                uid?: string;
                url?: string;
            };
        }[];
    link_attr?: {
        _attributes: {
            color?: number;
            direction?: "Infil"
            | "Exfil";
            method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
            order: "Ascending Check Points" | "Descending Check Points";
            planningmethod?: "Infil" | "Exfil";
            prefix: string;
            routetype: "Primary" | "Secondary";
            stroke?: string;
            style?: string;
            type?: string;
        };
    };
    marti?: {
        _attributes?: {};
        dest?: | {
            _attributes: {
                after?: string;
                callsign?: string;
                group?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            };
        }
        | {
            _attributes: {
                after?: string;
                callsign?: string;
                group?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            };
        }[];
    };
    mission?: {
        _attributes?: {
            authorUid?: string;
            guid?: string;
            name?: string;
            tool?: string;
            type?: string;
        };
        MissionChanges?: {
            MissionChange: | {
                contentUid: { _text: string };
                creatorUid: { _text?: string };
                details: {
                    _attributes: { callsign?: string; color?: string; type: string };
                    location?: { _attributes: { lat: ...; lon: ... } };
                };
                isFederatedChange: { _text: string };
                missionName: { _text: string };
                timestamp: { _text: string };
                type: { _text: string };
            }
            | {
                contentUid: { _text: string };
                creatorUid: { _text?: string };
                details: {
                    _attributes: {
                        callsign?: (...) | (...);
                        color?: (...) | (...);
                        type: string;
                    };
                    location?: { _attributes: ... };
                };
                isFederatedChange: { _text: string };
                missionName: { _text: string };
                timestamp: { _text: string };
                type: { _text: string };
            }[];
        };
        missionLayer?: {
            name?: { _text: string };
            parentUid?: { _text: string };
            type?: { _text: string };
            uid?: { _text: string };
        };
    };
    northRef?: { _attributes: { value: number } };
    precisionlocation?: {
        _attributes: { altsrc?: string; geopointsrc?: string };
    };
    range?: { _attributes: { value: number } };
    rangeUnits?: { _attributes: { value: number } };
    remarks?: {
        _attributes?: { source?: string; time?: string; to?: string };
        _text?: string;
    };
    sensor?: {
        _attributes: {
            azimuth?: number;
            displayMagneticReference?: number;
            elevation?: number;
            fov?: number;
            fovAlpha?: number;
            fovBlue?: number;
            fovGreen?: number;
            fovRed?: number;
            hideFov?: boolean;
            model?: string;
            north?: number;
            range?: number;
            rangeLines?: number;
            rangeLineStrokeColor?: number;
            rangeLineStrokeWeight?: number;
            roll?: number;
            strokeColor?: number;
            strokeWeight?: number;
            type?: string;
            version?: string;
            vfov?: number;
        };
    };
    shape?: {
        ellipse?: {
            _attributes: { angle: number; major: number; minor: number };
        };
        polyline?: {
            _attributes?: { closed?: boolean; color?: string; fillColor?: string };
            vertex?:
                | { _attributes: { lat: number; lon: number } }
                | { _attributes: { lat: number; lon: number } }[];
        };
    };
    status?: { _attributes: { battery?: string; readiness?: string } };
    strokeColor?: { _attributes?: { value?: number } };
    strokeStyle?: { _attributes?: { value?: string } };
    strokeWeight?: { _attributes?: { value?: number } };
    TakControl?: {
        TakProtocolSupport?: { _attributes?: { version?: string } };
        TakServerVersionInfo?: { _attributes?: { serverVersion?: string } };
    };
    takv?: {
        _attributes: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
    };
    tog?: { _attributes?: { enabled?: string } };
    track?: {
        _attributes?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
    };
    uid?: { _attributes: { Droid: string } };
    usericon?: { _attributes: { iconsetpath: string } };
}
Return Detail Object of CoT or create one if it doesn't yet exist and pass a reference

Returns {
    __chat?: {
        _attributes: {
            chatroom: string;
            groupOwner?: string;
            id: string;
            messageId?: string;
            parent?: string;
            senderCallsign: string;
        };
        chatgrp: any;
    };
    __forcedelete?: {};
    __geofence?: {
        _attributes: {
            boundingSphere?: number;
            elevationMonitored?: string;
            maxElevation?: string;
            minElevation?: string;
            monitor?: string;
            tracking?: string;
            trigger?: string;
        };
    };
    __group?: { _attributes?: { name: string; role: string } };
    __milsym?: {
        _attributes: { id: string };
        unitmodifier?:
            | { _attributes: { code: string }; _text?: string }
            | { _attributes: { code: string }; _text?: string }[];
    };
    __routeinfo?: {
        __navcues: {
            __navcue: | {
                _attributes: { id: string; text: string; voice: string };
                trigger: { _attributes: { mode: string; value: string } };
            }[]
            | {
                _attributes: { id: string; text: string; voice: string };
                trigger: { _attributes: { mode: string; value: string } };
            };
        };
    };
    __video?: {
        _attributes?: {
            sensor?: string;
            spi?: string;
            uid?: string;
            url?: string;
        };
        ConnectionEntry?: {
            _attributes: {
                address: string;
                alias?: string;
                bufferTime?: number;
                ignoreEmbeddedKLV?: boolean;
                networkTimeout?: number;
                path?: string;
                port?: number;
                protocol?: string;
                roverPort?: number;
                rtspReliable?: number;
                uid: string;
            };
        };
    };
    "_flow-tags_"?: any;
    ackrequest?: {
        _attributes: { ackrequested: boolean; tag: string; uid: string };
    };
    archive?: | { _attributes?: { value?: string } }
    | { _attributes?: { value?: string } }[];
    attachment_list?: { _attributes: { hashes: string } };
    bearing?: { _attributes: { value: number } };
    bearingUnits?: { _attributes: { value: number } };
    color?: { _attributes?: { argb?: number; value?: number } };
    contact?: {
        _attributes: {
            callsign?: string;
            endpoint?: string;
            name?: string;
            phone?: string;
        };
    };
    creator?: {
        _attributes: {
            callsign: string;
            time: string;
            type: string;
            uid: string;
        };
    };
    fileshare?: {
        _attributes: {
            filename: string;
            name: string;
            senderCallsign: string;
            senderUid: string;
            senderUrl: string;
            sha256: string;
            sizeInBytes: number;
        };
    };
    fillColor?: { _attributes?: { value?: number } };
    inclination?: { _attributes: { value: number } };
    labels_on?: { _attributes?: { value?: boolean } };
    link?:
        | {
            _attributes: {
                callsign?: string;
                mime?: string;
                parent_callsign?: string;
                point?: string;
                production_time?: string;
                relation?: string;
                remarks?: string;
                type?: string;
                uid?: string;
                url?: string;
            };
        }
        | {
            _attributes: {
                callsign?: string;
                mime?: string;
                parent_callsign?: string;
                point?: string;
                production_time?: string;
                relation?: string;
                remarks?: string;
                type?: string;
                uid?: string;
                url?: string;
            };
        }[];
    link_attr?: {
        _attributes: {
            color?: number;
            direction?: "Infil"
            | "Exfil";
            method: "Driving" | "Walking" | "Flying" | "Swimming" | "Watercraft";
            order: "Ascending Check Points" | "Descending Check Points";
            planningmethod?: "Infil" | "Exfil";
            prefix: string;
            routetype: "Primary" | "Secondary";
            stroke?: string;
            style?: string;
            type?: string;
        };
    };
    marti?: {
        _attributes?: {};
        dest?: | {
            _attributes: {
                after?: string;
                callsign?: string;
                group?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            };
        }
        | {
            _attributes: {
                after?: string;
                callsign?: string;
                group?: string;
                mission?: string;
                "mission-guid"?: string;
                path?: string;
                uid?: string;
            };
        }[];
    };
    mission?: {
        _attributes?: {
            authorUid?: string;
            guid?: string;
            name?: string;
            tool?: string;
            type?: string;
        };
        MissionChanges?: {
            MissionChange: | {
                contentUid: { _text: string };
                creatorUid: { _text?: string };
                details: {
                    _attributes: { callsign?: string; color?: string; type: string };
                    location?: { _attributes: { lat: ...; lon: ... } };
                };
                isFederatedChange: { _text: string };
                missionName: { _text: string };
                timestamp: { _text: string };
                type: { _text: string };
            }
            | {
                contentUid: { _text: string };
                creatorUid: { _text?: string };
                details: {
                    _attributes: {
                        callsign?: (...) | (...);
                        color?: (...) | (...);
                        type: string;
                    };
                    location?: { _attributes: ... };
                };
                isFederatedChange: { _text: string };
                missionName: { _text: string };
                timestamp: { _text: string };
                type: { _text: string };
            }[];
        };
        missionLayer?: {
            name?: { _text: string };
            parentUid?: { _text: string };
            type?: { _text: string };
            uid?: { _text: string };
        };
    };
    northRef?: { _attributes: { value: number } };
    precisionlocation?: {
        _attributes: { altsrc?: string; geopointsrc?: string };
    };
    range?: { _attributes: { value: number } };
    rangeUnits?: { _attributes: { value: number } };
    remarks?: {
        _attributes?: { source?: string; time?: string; to?: string };
        _text?: string;
    };
    sensor?: {
        _attributes: {
            azimuth?: number;
            displayMagneticReference?: number;
            elevation?: number;
            fov?: number;
            fovAlpha?: number;
            fovBlue?: number;
            fovGreen?: number;
            fovRed?: number;
            hideFov?: boolean;
            model?: string;
            north?: number;
            range?: number;
            rangeLines?: number;
            rangeLineStrokeColor?: number;
            rangeLineStrokeWeight?: number;
            roll?: number;
            strokeColor?: number;
            strokeWeight?: number;
            type?: string;
            version?: string;
            vfov?: number;
        };
    };
    shape?: {
        ellipse?: {
            _attributes: { angle: number; major: number; minor: number };
        };
        polyline?: {
            _attributes?: { closed?: boolean; color?: string; fillColor?: string };
            vertex?:
                | { _attributes: { lat: number; lon: number } }
                | { _attributes: { lat: number; lon: number } }[];
        };
    };
    status?: { _attributes: { battery?: string; readiness?: string } };
    strokeColor?: { _attributes?: { value?: number } };
    strokeStyle?: { _attributes?: { value?: string } };
    strokeWeight?: { _attributes?: { value?: number } };
    TakControl?: {
        TakProtocolSupport?: { _attributes?: { version?: string } };
        TakServerVersionInfo?: { _attributes?: { serverVersion?: string } };
    };
    takv?: {
        _attributes: {
            device?: string;
            os?: string;
            platform?: string;
            version?: string;
        };
    };
    tog?: { _attributes?: { enabled?: string } };
    track?: {
        _attributes?: {
            course?: string;
            eCourse?: string;
            eSlope?: string;
            eSpeed?: string;
            slope?: string;
            speed?: string;
        };
    };
    uid?: { _attributes: { Droid: string } };
    usericon?: { _attributes: { iconsetpath: string } };
}
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:141

is_airborne

is_airborne(): boolean
Determines if the CoT message represents an Airborne Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:413

is_assumed

is_assumed(): boolean
Determines if the CoT message represents an Assumed Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:359

is_atom

is_atom(): boolean
Determines if the CoT message represents an Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:404

is_chat

is_chat(): boolean
Determines if the CoT message represents a Chat Message

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:314

is_equipment

is_equipment(): boolean
Determines if the CoT message represents Equipment

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:449

is_faker

is_faker(): boolean
Determines if the CoT message represents a Faker Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:395

is_friend

is_friend(): boolean
Determines if the CoT message represents a Friendly Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:323

is_ground

is_ground(): boolean
Determines if the CoT message represents a Ground Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:422

is_hostile

is_hostile(): boolean
Determines if the CoT message represents a Hostile Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:332

is_installation

is_installation(): boolean
Determines if the CoT message represents an Installation

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:431

is_joker

is_joker(): boolean
Determines if the CoT message represents a Joker Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:386

is_neutral

is_neutral(): boolean
Determines if the CoT message represents a Neutral Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:368

is_pending

is_pending(): boolean
Determines if the CoT message represents a Pending Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:350

is_stale

is_stale(): boolean
Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:296

is_subsurface

is_subsurface(): boolean
Determines if the CoT message represents a Subsurface Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:467

is_surface

is_surface(): boolean
Determines if the CoT message represents a Surface Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:458

is_suspect

is_suspect(): boolean
Determines if the CoT message represents a Suspect Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:377

is_tasking

is_tasking(): boolean
Determines if the CoT message represents a Tasking Message

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:305

is_uav

is_uav(): boolean
Determines if the CoT message represents a UAV Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:476

is_unknown

is_unknown(): boolean
Determines if the CoT message represents a Unknown Element

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:341

is_vehicle

is_vehicle(): boolean
Determines if the CoT message represents a Vehicle

Returns boolean
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:440

position

position(position?: number[]): number[]
Parameters
- Optionalposition: number[]
Returns number[]
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:214

sensor

sensor(
    sensor?: {
        azimuth?: number;
        displayMagneticReference?: number;
        elevation?: number;
        fov?: number;
        fovAlpha?: number;
        fovBlue?: number;
        fovGreen?: number;
        fovRed?: number;
        hideFov?: boolean;
        model?: string;
        north?: number;
        range?: number;
        rangeLines?: number;
        rangeLineStrokeColor?: number;
        rangeLineStrokeWeight?: number;
        roll?: number;
        strokeColor?: number;
        strokeWeight?: number;
        type?: string;
        version?: string;
        vfov?: number;
    },
): null
| { coordinates: number[][][]; type: "Polygon" }
Parameters
- Optionalsensor: {
      azimuth?: number;
      displayMagneticReference?: number;
      elevation?: number;
      fov?: number;
      fovAlpha?: number;
      fovBlue?: number;
      fovGreen?: number;
      fovRed?: number;
      hideFov?: boolean;
      model?: string;
      north?: number;
      range?: number;
      rangeLines?: number;
      rangeLineStrokeColor?: number;
      rangeLineStrokeWeight?: number;
      roll?: number;
      strokeColor?: number;
      strokeWeight?: number;
      type?: string;
      version?: string;
      vfov?: number;
  }
Returns null | { coordinates: number[][][]; type: "Polygon" }
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:226

type

type(type?: string): string
Returns or sets the Callsign of the CoT
Parameters
- Optionaltype: string
Returns string
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:92

uid

uid(uid?: string): string
Returns or sets the UID of the CoT
Parameters
- Optionaluid: string
Returns string
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:84

`Static`ping

ping(): CoT
Return a CoT Message

Returns CoT
- Defined in node_modules/@tak-ps/node-cot/lib/cot.ts:483

Class CoT

Param: cot

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CoT

Properties

metadata

path

raw

Methods

addDest

Parameters

Returns CoT

addLink

Parameters

Returns CoT

addVideo

Parameters

Returns CoT

archived

Parameters

Returns boolean

callsign

Parameters

Returns string

creator

Parameters

Returns undefined | { callsign: string; time: string; type: string; uid: string }

detail

is_airborne

Returns boolean

is_assumed

Returns boolean

is_atom

Returns boolean

is_chat

Returns boolean

is_equipment

Returns boolean

is_faker

Returns boolean

is_friend

Returns boolean

is_ground

Returns boolean

is_hostile

Returns boolean

is_installation

Returns boolean

is_joker

Returns boolean

is_neutral

Returns boolean

is_pending

Returns boolean

is_stale

Returns boolean

is_subsurface

Returns boolean

is_surface

Returns boolean

is_suspect

Returns boolean

is_tasking

Returns boolean

is_uav

Returns boolean

is_unknown

Returns boolean

is_vehicle

Returns boolean

position

Parameters

Returns number[]

sensor

`Static`ping