Class WeatherGrid_GridFile

Information about a grid file.

author: "Travis Redpath"

Hierarchy

WeatherGrid_GridFile

Index

Properties

Accessors

Methods

Properties

Private _filename

_filename: string = ""

The location of the grid file (required).

Private _speed

_speed: number = -1

The wind speed (required).

projection

projection: string = ""

The projection file for the grid file (required).

sector

sector: WeatherGridSector

The sector to apply this grid file to (required).

Accessors

filename

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

Get the location of the file containing the grid data.

throws

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

Returns string
Set the location of the file containing the grid data. The file must either be an attachment or exist on the disk (if SocketMsg.skipFileTests is not set).

throws

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

Parameters
- value: string
Returns void

speed

get speed(): number
set speed(value: number): void

Get the wind speed.

throws

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

Returns number
Set the wind speed (km/h).

throws

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

Parameters
- value: number
Returns void

Methods

checkValid

checkValid(): Array<ValidationError>

Find a list of all errors in the weather grid file.

Returns Array<ValidationError>

A list of errors.

isValid

isValid(): boolean

Check to make sure all parameters have been set to valid values.

Returns boolean