Options
All
  • Public
  • Public/Protected
  • All
Menu

Information about an ignition input.

author

"Travis Redpath"

Hierarchy

  • Ignition

Index

Constructors

constructor

Properties

Private _filename

_filename: string = ""

The filename associated with this ignition. Only valid if type is FILE.

Private _id

_id: string

The name of the ignition. The name must be unique amongst ignition collections.

Private _startTime

_startTime: DateTime

The ignition start time (required).

attributes

attributes: AttributeEntry[] = new Array<AttributeEntry>()

A list of attributes for the ignition. Not valid for {@link #filename} types. Valid types for the value are Integer, Long, Double, and String.

comments

comments: string = ""

User comments about the ignition (optional).

feature

feature: LatLon[] = new Array<LatLon>()

An array of LatLon describing the ignition. Only valid if type is POLYLINE, POLYGON, or POINT.

type

type: IgnitionType = -1

The type of ignition (required).

Static Private Readonly PARAM_IGNITION

PARAM_IGNITION: "ignition" = "ignition"

Static Protected counter

counter: number = 0

Accessors

filename

  • get filename(): string
  • set filename(value: string): void

id

  • get id(): string
  • set id(value: string): void
  • Get the name of the ignition.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    Returns string

  • Set the name of the ignition. Must be unique amongst the ignition collection. Cannot be null or empty.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    Parameters

    • value: string

    Returns void

lStartTime

  • get lStartTime(): DateTime
  • set lStartTime(value: DateTime): void

startTime

  • get startTime(): string
  • set startTime(value: string): void
  • Get the ignition start time as an ISO8601 string.

    deprecated

    Returns string

  • Set the ignition start time using a string. Cannot be null or empty. Must be formatted in ISO8601.

    throws

    If SocketMsg.inlineThrowOnError is set a RangeError will be thrown if value is not valid.

    deprecated

    Parameters

    • value: string

    Returns void

Methods

addPoint

  • Add a new point to the ignition shape. Only valid for POLYLINE, POLYGON, or POINT.

    Parameters

    • point: LatLon

      The point to add to the ignition.

    Returns Ignition

    The current ignition object so that multiple additions can be chained.

checkValid

getId

  • getId(): string
  • Returns string

isValid

  • isValid(): boolean
  • Checks to see if all required values have been set.

    Returns boolean

setName

  • setName(name: string): void
  • Set the name of the ignition. This name must be unique within the simulation. The name will get a default value when the ignition is constructed but can be overriden with this method.

    Parameters

    • name: string

    Returns void

stream

  • stream(builder: Socket): void
  • Streams the ignition to a socket.

    Parameters

    • builder: Socket

    Returns void