Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetcdfReader

Hierarchy

  • NetcdfReader

Index

Constructors

constructor

Properties

buffer

buffer: IOBuffer

header

Accessors

dimensions

  • get dimensions(): undefined | any[]
  • Returns undefined | any[]

    • List of dimensions with:
      • name: String with the name of the dimension
      • size: Number with the size of the dimension

globalAttributes

  • get globalAttributes(): undefined | any[]
  • Returns undefined | any[]

    • List of global attributes with:
      • name: String with the name of the attribute
      • type: String with the type of the attribute
      • value: A number or string with the value of the attribute

recordDimension

  • Returns undefined | NetCDFRecordDimension

    • Metadata for the record dimension
      • length: Number of elements in the record dimension
      • id: Id number in the list of dimensions for the record dimension
      • name: String with the name of the record dimension
      • recordStep: Number with the record variables step size

variables

  • get variables(): undefined | any[]
  • Returns undefined | any[]

    • List of variables with:
      • name: String with the name of the variable
      • dimensions: Array with the dimension IDs of the variable
      • attributes: Array with the attributes of the variable
      • type: String with the type of the variable
      • size: Number with the size of the variable
      • offset: Number with the offset where of the variable begins
      • record: True if is a record variable, false otherwise

version

  • get version(): "classic format" | "64-bit offset format"

Methods

getDataVariable

  • getDataVariable(variableName: string | {}): any[]
  • Retrieves the data for a given variable

    Parameters

    • variableName: string | {}

      Name of the variable to search or variable object

    Returns any[]

    • List with the variable values

hasDataVariable

  • hasDataVariable(variableName: string): boolean
  • Checks if a variable is available

    Parameters

    • variableName: string

      Name of the variable to check

    Returns boolean

    • Variable existence

Generated using TypeDoc