[Home] Type Unidata.NetCDF.Variable


Representation of a variable in a dataset. The NetCDF.DesignTime.DataFileProvider generates erased subtypes of this class that map the Item property to Get and Put calls, maps named properties to GetAttribute and SetAttribute calls and equips those properties as well as the GetSlice method with the proper typed signatures.

Type Description

type Variable

Constructors

MemberDescription
new Variable (ncid, varid)
ncid: int ref
varid: int
returns : Variable

Instance Members

MemberDescription
variable.Get (index)
Retrieves a single value of the variable by index array.
index: uint64 []
returns : obj

variable.GetAttribute (name)
Retrieves a single attribute of the variable by name.
name: string
returns : obj

variable.GetAttributes ()
Retrieves all attributes of the variable.
returns : (string * obj) []

variable.GetDimensions ()
Reifies the dimensions of this variable.
returns : Dimension []

variable.GetFillValue ()
Retrieves the uninitialized fill value of this variable, if any.
returns : obj

variable.GetNetCDFType ()
Retrieves the NetCDF type of the variable.
returns : NetCDFType

variable.GetSlice (index, ?reshape)
Extracts a slice from the variable by index range array. If reshape is given and not false, the result becomes a two-, three- or four-dimensional array of numeric values, when appropriate; otherwise the result will always be a one-dimensional array or string.
index: uint64 option []
?reshape: bool option
returns : obj

variable.GetStartCount (index)
Converts an F# index range to a NetCDF start index and counts.
index: uint64 option []
returns : uint64 [] * uint64 []

variable.Name : string
The symbolic name of the variable.

variable.Name () <- v
The symbolic name of the variable.

variable.Put (index, v)
Stores a single value of the variable by index array.
index: uint64 []
v: obj
returns : unit

variable.PutSlice (index, v)
Stores a slice of the variable by index range array. Two-, three- or four-dimensional arrays of numeric values are allowed as values where appropriate, but one dimensional arrays can be used, too.
index: uint64 option []
v: obj
returns : unit

variable.Rank : int
The number of dimensions for the variable.

variable.SetAttribute (name, v)
Sets a single attribute of the variable by name.
name: string
v: '?4827
returns : unit

variable.SetFillValue (v)
Sets or clears the uninitialized fill value of this variable.
v: obj
returns : unit

variable.ncid : int

variable.varid : int

See Also

Unidata.NetCDF


Documentation for assembly Unidata.NetCDF, version 1.0.5002.0, generated using the F# Programming Power Pack