Options
All
  • Public
  • Public/Protected
  • All
Menu

Information about a grid input file.

author

"Travis Redpath"

Hierarchy

  • GridFile

Index

Constructors

constructor

Properties

Private _comment

_comment: string = ""

Comment about the grid file (optional).

Private _filename

_filename: string = ""

The location of the file containing the grid data (required).

Private _id

_id: string

The name of the grid file. Must be unique amongst the grid file collection.

Private _projection

_projection: string = ""

The projection file for the grid file (required).

type

type: GridFileType = GridFileType.NONE

The type of grid file (required).

Static Private Readonly PARAM_GRID_FILE

PARAM_GRID_FILE: "inputgridfile" = "inputgridfile"

Static Protected counter

counter: number = 0

Accessors

comment

  • get comment(): string
  • set comment(value: string): void
  • Get the comment about the grid file.

    Returns string

  • Set the comment about the grid file.

    Parameters

    • value: string

    Returns void

filename

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

id

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

    throws

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

    Returns string

  • Set the name of the grid file. Must be unique amongst the grid file 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

projection

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

Methods

checkValid

  • Find all errors that may be in the grid file.

    Returns Array<ValidationError>

    A list of errors that were found.

getId

  • getId(): string
  • Returns string

isValid

  • isValid(): boolean
  • Are all required values set.

    Returns boolean

setName

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

    Parameters

    • name: string

    Returns void

stream

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

    Parameters

    • builder: Socket

    Returns void