Options
All
  • Public
  • Public/Protected
  • All
Menu

An asset that can be used to stop a simulation early.

author

"Travis Redpath"

Hierarchy

  • AssetFile

Index

Constructors

constructor

Properties

Private _filename

_filename: string = ""

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

Private _id

_id: string

The name of the asset. The name must be unique amongst asset file collections.

buffer

buffer: number = -1.0

The buffer size to use for line or point assets. If negative, no buffer will be used.

comments

comments: string = ""

User comments about the asset (optional).

feature

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

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

type

type: AssetShapeType = -1

The type of asset (required).

Static Private Readonly PARAM_ASSET_FILE

PARAM_ASSET_FILE: "asset_file" = "asset_file"

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

Methods

checkValid

  • Find all errors that may exist in the asset.

    Returns Array<ValidationError>

    A list of errors that were found.

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 asset. This name must be unique within the simulation. The name will get a default value when the asset 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