NetCDFVarInfo (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.data.NetCDFVarInfo

所有已实现的接口:

IDisposable
```
public class NetCDFVarInfo
extends com.supermap.data.InternalHandleDisposable
```
NetCDF 文件中变量信息类，存储 NetCDF 中某一变量的相关信息。
NetCDF(network Common Data Format)，即网络通用数据格式。最早是由美国国家科学委员会资助的计划 Unidata 发展，其用意是在 Unidata 计划中不同的应用项目下，提供一种可以通用的数据存取方式，NetCDF 文件初始目的是用于存储气象科学中的数据，现在已经成为许多数据采集软件的生成文件的格式。目前可供存储的数据包括单点的观测值、时间序列、规则排列的网格以及人造卫星或雷达影像档案。

一个 netcdf 文件的结构包括以下对象：

1、变量(Variables)

变量对应着真实的物理数据。NetCDF 中的变量是一个 N 维数组，数组的维数就是实际问题中的自变量个数，数组的值就是观测得到的物理值。变量在 NetCDF 中的存储类型有六种，ASCII 字符(char)，字节(byte)，短整型(short)，整型(int)，浮点(float)，双精度(double)。例如：变量类型、单位及内容。

2、维(dimension)

一个维对应着函数中的某个自变量，或者说函数图象中的一个坐标轴，在线性代数中就是一个N维向量的一个分量。在 NetCDF 中，一个维具有一个名字和范围。在 NetCDF 中，维的长度基本都是有限的，最多只能有一个具有无限长度的维。例如，时间、深度、经度、纬度。

3、属性(Attribute)

属性是对变量值和维的具体物理含义的注释或者解释。因为变量和维在 NetCDF 中都只是无量纲的数字，要想让人们明白这些数字的具体含义，就需要属性这个对象。在 NetCDF 中，属性由一个属性名和一个属性值（一般为字符串）组成。

另外，NetCDF 还有一个配对文件，为 CDL 文件。CDL 全称为 Network Common data form Description Language，它是用来描述 NetCDF 文件的结构的一种语法格式。它包括前面所说的三种 NetCDF 对象(变量、维、属性)的具体定义。

注意：该类不可创建，只能从数据源，或者数据集中取出，然后进行设置。

构造器概要

构造器
构造器和说明
`NetCDFVarInfo()` 构造一个新的 NetCDFVarInfo 对象。
`NetCDFVarInfo(NetCDFVarInfo datasetNetCDFInfo)` 根据给定的 NetCDFVarInfo 对象构造一个与其完全相同的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`String[]`	`getDimension()` 返回当前 NetCDF 中变量的维度名称数组，当不存在此变量时，返回空。
`int`	`getDimSize(String value)` 返回指定维度的索引范围。
`String`	`getLongName()` 返回当前变量的详细描述信息，当不存在此变量时，返回空。
`String`	`getName()` 返回当前 NetCDF 中变量信息（NetCDFVarInfo）对象的名称，对应 NetCDF 文件某一变量名字。
`String`	`getOptionalDimension()` 返回滑动维度名。
`int`	`getOptionalDimIndex()` 返回滑动维度的索引。
`String`	`getUnit()` 返回当前 NetCDF 中变量信息（NetCDFVarInfo）对象的单位，对应 NetCDF 文件某一变量的单位。
`String`	`getXDimension()` 返回 X 维度的名称。
`int`	`getXEndIndex()` 返回 X 维度的终止索引。
`int`	`getXStartIndex()` 返回 X 维度的起始索引。
`String`	`getYDimension()` 返回 Y 维度的名称。
`int`	`getYEndIndex()` 返回 Y 维度的终止索引。
`int`	`getYStartIndex()` 返回 Y 维度的起始索引。
`boolean`	`setOptionalDimension(String value)` 返回滑动维度名是否设置成功。
`boolean`	`setOptionalDimIndex(int value)` 返回滑动维度的索引是否设置成功。
`boolean`	`setXDimension(String value)` 返回 X 维度的名称是否设置成功。
`boolean`	`setXEndIndex(int value)` 返回 X 维度的终止索引设置是否成功。
`boolean`	`setXStartIndex(int value)` 返回 X 维度的起始索引是否设置成功。
`boolean`	`setYDimension(String value)` 返回 Y 维度的名称是否设置成功。
`boolean`	`setYEndIndex(int value)` 返回 Y 维度的终止索引是否设置成功。
`boolean`	`setYStartIndex(int value)` 返回 Y 维度的起始索引设置是否成功。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NetCDFVarInfo
```
public NetCDFVarInfo()
```
    构造一个新的 NetCDFVarInfo 对象。
  - NetCDFVarInfo
```
public NetCDFVarInfo(NetCDFVarInfo datasetNetCDFInfo)
```
    根据给定的 NetCDFVarInfo 对象构造一个与其完全相同的新对象。
    
    参数:
    
    datasetNetCDFInfo - 给定的 NetCDFVarInfo 对象。
- 方法详细资料
  - getName
```
public String getName()
```
    返回当前 NetCDF 中变量信息（NetCDFVarInfo）对象的名称，对应 NetCDF 文件某一变量名字。
    
    返回:
    
    当前 NetCDF 中变量信息（NetCDFVarInfo）对象的名称，对应 NetCDF 文件某一变量名字。
  - getUnit
```
public String getUnit()
```
    返回当前 NetCDF 中变量信息（NetCDFVarInfo）对象的单位，对应 NetCDF 文件某一变量的单位。
    
    返回:
    
    当前 NetCDF 中变量信息（NetCDFVarInfo）对象的单位，对应 NetCDF 文件某一变量的单位。
  - getLongName
```
public String getLongName()
```
    返回当前变量的详细描述信息，当不存在此变量时，返回空。
    
    返回:
    
    当前变量的详细描述信息，当不存在此变量时，返回空。
  - getDimension
```
public String[] getDimension()
```
    返回当前 NetCDF 中变量的维度名称数组，当不存在此变量时，返回空。
    
    返回:
    
    当前 NetCDF 中变量的维度名称数组，当不存在此变量时，返回空。
  - getDimSize
```
public int getDimSize(String value)
```
    返回指定维度的索引范围。
    假设名称为X的维度共有 N 个索引值（0，1，……，N-1），则X维的索引范围为 N。
    
    参数:
    
    value - 指定的维度名称。
    
    返回:
    
    指定维度的索引范围。
  - getXDimension
```
public String getXDimension()
```
    返回 X 维度的名称。
    
    返回:
    
    X 维度的名称。
  - setXDimension
```
public boolean setXDimension(String value)
```
    返回 X 维度的名称是否设置成功。
    
    参数:
    
    value - X 维度的名称。
    
    返回:
    
    一个布尔值，表示 X 维度的名称是否设置成功。true 表示设置成功；否则不成功。
  - getXStartIndex
```
public int getXStartIndex()
```
    返回 X 维度的起始索引。
    
    返回:
    
    X 维度的起始索引。
  - setXStartIndex
```
public boolean setXStartIndex(int value)
```
    返回 X 维度的起始索引是否设置成功。
    
    参数:
    
    value - X 维度的起始索引。
    
    返回:
    
    一个布尔值，表示 X 维度的起始索引是否设置成功。true 表示设置成功；否则不成功。
  - getXEndIndex
```
public int getXEndIndex()
```
    返回 X 维度的终止索引。
    
    返回:
    
    X 维度的终止索引。
  - setXEndIndex
```
public boolean setXEndIndex(int value)
```
    返回 X 维度的终止索引设置是否成功。
    
    参数:
    
    value - X 维度的终止索引。
    
    返回:
    
    一个布尔值，表示 X 维度的终止索引设置是否成功。true 表示设置成功；否则不成功。
  - getYDimension
```
public String getYDimension()
```
    返回 Y 维度的名称。
    
    返回:
    
    Y 维度的名称。
  - setYDimension
```
public boolean setYDimension(String value)
```
    返回 Y 维度的名称是否设置成功。
    
    参数:
    
    value - Y 维度的名称。
    
    返回:
    
    一个布尔值，表示 Y 维度的名称是否设置成功。true 表示设置成功；否则不成功。
  - getYStartIndex
```
public int getYStartIndex()
```
    返回 Y 维度的起始索引。
    
    返回:
    
    Y 维度的起始索引。
  - setYStartIndex
```
public boolean setYStartIndex(int value)
```
    返回 Y 维度的起始索引设置是否成功。
    
    参数:
    
    value - Y 维度的起始索引。
    
    返回:
    
    一个布尔值，表示 Y 维度的起始索引是否设置成功。true 表示设置成功；否则不成功。
  - getYEndIndex
```
public int getYEndIndex()
```
    返回 Y 维度的终止索引。
    
    返回:
    
    Y 维度的终止索引。
  - setYEndIndex
```
public boolean setYEndIndex(int value)
```
    返回 Y 维度的终止索引是否设置成功。
    
    参数:
    
    value - Y 维度的终止索引。
    
    返回:
    
    一个布尔值，表示 Y 维度的终止索引是否设置成功。true 表示设置成功；否则不成功。
  - getOptionalDimension
```
public String getOptionalDimension()
```
    返回滑动维度名。
    为读取或显示多维数据，需要对数据进行降维处理，一般采用固定某一维度的数值的方式来实现。即，将某一维度设置为滑动维度，当滑动维度的数值固定时，可以获得降维后的数据，从而方便数据的读取或显示。通常选取时间维度为滑动维度。
    
    以 4 维数据为例，分别有 X、Y、W、T 四个维度，其中 X、Y 为坐标，W 降水，T 为时间。若取 T 为滑动维度，则以时间维度 T 的索引进行滑动，得到维度 T 取不同值时，X、Y、W 这三个维度的数据，当时间固定为某值时，得到不同点的降水量；当维度 T 滑动并依次取各个索引值时，则得到各点降水量随时间的变化。
    
    返回:
    
    滑动维度名。
  - setOptionalDimension
```
public boolean setOptionalDimension(String value)
```
    返回滑动维度名是否设置成功。
    为读取或显示多维数据，需要对数据进行降维处理，一般采用固定某一维度的数值的方式来实现。即，将某一维度设置为滑动维度，当滑动维度的数值固定时，可以获得降维后的数据，从而方便数据的读取或显示。通常选取时间维度为滑动维度。
    
    以 4 维数据为例，分别有 X、Y、W、T 四个维度，其中 X、Y 为坐标，W 降水，T 为时间。若取 T 为滑动维度，则以时间维度 T 的索引进行滑动，得到维度 T 取不同值时，X、Y、W 这三个维度的数据，当时间固定为某值时，得到不同点的降水量；当维度 T 滑动并依次取各个索引值时，则得到各点降水量随时间的变化。
    
    参数:
    
    value - 滑动维度名。
    
    返回:
    
    一个布尔值，表示滑动维度名是否设置成功。true 表示设置成功；否则不成功。
  - getOptionalDimIndex
```
public int getOptionalDimIndex()
```
    返回滑动维度的索引。
    为读取或显示多维数据，需要对数据进行降维处理，一般采用固定某一维度的数值的方式来实现。即，将某一维度设置为滑动维度，当滑动维度的数值固定时，可以获得降维后的数据，从而方便数据的读取或显示。通常选取时间维度为滑动维度。
    
    以 4 维数据为例，分别有 X、Y、W、T 四个维度，其中 X、Y 为坐标，W 降水，T 为时间。若取 T 为滑动维度，则以时间维度 T 的索引进行滑动，得到维度 T 取不同值时，X、Y、W 这三个维度的数据，当时间固定为某值时，得到不同点的降水量；当维度 T 滑动并依次取各个索引值时，则得到各点降水量随时间的变化。
    
    返回:
    
    滑动维度的索引。
  - setOptionalDimIndex
```
public boolean setOptionalDimIndex(int value)
```
    返回滑动维度的索引是否设置成功。
    为读取或显示多维数据，需要对数据进行降维处理，一般采用固定某一维度的数值的方式来实现。即，将某一维度设置为滑动维度，当滑动维度的数值固定时，可以获得降维后的数据，从而方便数据的读取或显示。通常选取时间维度为滑动维度。
    
    以 4 维数据为例，分别有 X、Y、W、T 四个维度，其中 X、Y 为坐标，W 降水，T 为时间。若取 T 为滑动维度，则以时间维度 T 的索引进行滑动，得到维度 T 取不同值时，X、Y、W 这三个维度的数据，当时间固定为某值时，得到不同点的降水量；当维度 T 滑动并依次取各个索引值时，则得到各点降水量随时间的变化。
    
    参数:
    
    value - 滑动维度的索引。
    
    返回:
    
    一个布尔值，表示滑动维度的索引是否设置成功。true 表示设置成功；否则不成功。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。

类 NetCDFVarInfo

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

从类继承的方法 java.lang.Object

构造器详细资料

NetCDFVarInfo

NetCDFVarInfo

方法详细资料

getName

getUnit

getLongName

getDimension

getDimSize

getXDimension

setXDimension

getXStartIndex

setXStartIndex

getXEndIndex

setXEndIndex

getYDimension

setYDimension

getYStartIndex

setYStartIndex

getYEndIndex

setYEndIndex

getOptionalDimension

setOptionalDimension

getOptionalDimIndex

setOptionalDimIndex

dispose