java.lang.Object
- org.meteoinfo.data.meteodata.Variable

```
public class Variable
extends Object
```
作者:

Yaqiang Wang

字段概要

字段
修饰符和类型	字段	说明
`protected double`	`addOffset`
`protected List<Attribute>`	`attributes`
`protected List<Dimension>`	`dimensions`
`protected double`	`fillValue`
`int`	`Number`
`protected double`	`scaleFactor`
`protected int[]`	`shape`

构造器概要

构造器
构造器说明

Variable()
Constructor

Variable(int aNum, String aName, String aDesc, String aUnit)
Constructor

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`void`	`addAttribute(String attName, double attValue)`	Add attribute
`void`	`addAttribute(String attName, String attValue)`	Add attribute
`void`	`addAttribute(String attName, List attValue)`	Add attribute
`void`	`addAttribute(Attribute attr)`	Add an attribute
`void`	`addDimension(int idx, Dimension dim)`	Add a dimension
`void`	`addDimension(String tstr, List<Number> values)`	Add a dimension
`void`	`addDimension(Dimension dim)`	Add a dimension
`void`	`addDimension(DimensionType dType, List<Number> values)`	Add a dimension
`void`	`addLevel(double levelValue)`	Add a level
`Object`	`clone()`	Clone
`boolean`	`dimensionContains(Variable var)`	If the dimensions contains the diemsions of another variable
`boolean`	`dimensionEquales(Variable var)`	If the dimensions equales with another variable
`boolean`	`dimensionSizeEquals(Variable var)`	If the dimensions size equales with another variable
`boolean`	`equals(Variable aVar)`	Determine if two parameter are equal
`Attribute`	`findAttribute(String name)`	Find an attribute by name
`Attribute`	`findAttributeIgnoreCase(String name)`	Find an attribute by name ignoring string case
`double`	`getAddOffset()`	Get add offset value
`int`	`getAttNumber()`	Get attribute number
`Attribute`	`getAttribute(int index)`	Get attribute
`int`	`getAttributeIndex(String attName)`	Get attribute index by name, return -1 if the name not exist.
`List<Attribute>`	`getAttributes()`	Get attributes
`String`	`getAttributeString(String attName)`	Get attribute value string by name
`org.meteoinfo.ndarray.Array`	`getCachedData()`	Get cached data array
`org.meteoinfo.ndarray.DataType`	`getDataType()`	Get data type
`String`	`getDescription()`	Get description
`Dimension`	`getDimension(int index)`	Get dimension
`Dimension`	`getDimension(DimensionType dimType)`	Get dimension by type
`List<Dimension>`	`getDimensions()`	Get dimensions
`List<Dimension>`	`getDimensions(org.meteoinfo.ndarray.Section section)`	Get dimensions by section
`int[]`	`getDimIds()`	Get dimension identifers
`int`	`getDimIndex(Dimension aDim)`	Get index of a dimension
`int`	`getDimLength(int idx)`	Get dimension length
`int`	`getDimNumber()`	Get dimension number
`double`	`getFillValue()`	Get fill value
`String`	`getHDFPath()`	Get HDF path
`Dimension`	`getLevelDimension(Variable var)`	Get level dimension for SWATH data variable
`List<Integer>`	`getLevelIdxs()`	Get level index list - for ARL data
`int`	`getLevelNum()`	Get level number
`List<Double>`	`getLevels()`	Get levels
`int`	`getLevelType()`	Get level type
`String`	`getName()`	Get name
`double`	`getScaleFactor()`	Get scale factor value
`String`	`getShortName()`	Get short name
`int`	`getStaggerDimIndex()`	Get stagger dimension index
`Dimension`	`getTDimension()`	Get T dimension
`List<LocalDateTime>`	`getTimes()`	Get times
`int`	`getTrueLevelNumber()`	Get true level number
`String`	`getUnits()`	Set units
`int`	`getVarId()`	Get variable identifer
`List<Integer>`	`getVarInLevelIdxs()`	Get variable index in level index list - for ARL data
`Dimension`	`getXDimension()`	Get X dimension
`Dimension`	`getYDimension()`	Get Y dimension
`Dimension`	`getZDimension()`	Get Z dimension
`boolean`	`hasCachedData()`	Check has cached data or not
`boolean`	`hasDimension(int dimId)`	Determine if the variable has a dimension
`boolean`	`hasNullDimension()`	If the variable has a null dimension
`boolean`	`hasXtrackDimension()`	Determine if has Xtrack dimension
`boolean`	`isDimVar()`	Get if the variable is dimension variable
`boolean`	`isMemberOfStructure()`	Get if the variable is a member of a structure
`boolean`	`isPlottable()`	Get if the variable is plottable (has both X and Y dimension)
`boolean`	`isStation()`	Get if the variable is station data set
`boolean`	`isSwath()`	Get if the variable is swath data set
`void`	`resetShape()`	Use when dimensions have changed, to recalculate the shape.
`List<Dimension>`	`sectionDimensions(int[] origin, int[] size, int[] stride)`	Section dimensions
`void`	`setAddOffset(double value)`	Set add offset value
`void`	`setCachedData(org.meteoinfo.ndarray.Array value)`	Set cached data array
`void`	`setDataType(org.meteoinfo.ndarray.DataType value)`	Set data type
`void`	`setDescription(String value)`	Set description
`void`	`setDimension(int idx, Dimension aDim)`	Set dimension
`void`	`setDimension(String tstr, List<Number> values, boolean reverse)`	Set a dimension
`void`	`setDimension(String tstr, List<Number> values, boolean reverse, int index)`	Set a dimension
`void`	`setDimension(Dimension aDim)`	Set dimension
`void`	`setDimension(Dimension aDim, DimensionType dimType)`	Set dimension by dimension type
`void`	`setDimensions(List<Dimension> dims)`	Set dimensions
`void`	`setDimVar(boolean value)`	Set if the variable is dimension variable
`void`	`setFillValue(double value)`	Set fill value
`void`	`setHDFPath(String value)`	Set HDF path
`void`	`setLevelIdxs(List<Integer> value)`	Set level index list
`void`	`setLevels(List<Double> value)`	Set levels
`void`	`setLevelType(int value)`	Set level type
`void`	`setMemberOfStructure(boolean value)`	Set if the variable is a member of a structure
`void`	`setName(String value)`	Set name
`void`	`setScaleFactor(double value)`	Set scale factor value
`void`	`setShortName(String value)`	Set short name
`void`	`setStation(boolean value)`	Set if the variable is station data set
`void`	`setSwath(boolean value)`	Set if the variable is swath data set
`void`	`setTDimension(Dimension value)`	Set T dimension
`void`	`setUnits(String value)`	Set units
`void`	`setVarId(int value)`	Set variable identifer
`void`	`setVarInLevelIdxs(List<Integer> value)`	Set variable index in level index list - for ARL data
`void`	`setXDimension(Dimension value)`	Set X dimension
`void`	`setYDimension(Dimension value)`	Set Y dimension
`void`	`setZDimension(Dimension value)`	Set Z dimension
`boolean`	`tEquals(Variable aVar)`	Determine if two parameter are totally equal
`String`	`toString()`	To string
`void`	`updateZDimension()`	Update z dimension from levels

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

- 字段详细资料
  - Number
```
public int Number
```
  - shape
```
protected int[] shape
```
  - dimensions
```
protected List<Dimension> dimensions
```
  - attributes
```
protected List<Attribute> attributes
```
  - addOffset
```
protected double addOffset
```
  - scaleFactor
```
protected double scaleFactor
```
  - fillValue
```
protected double fillValue
```
- 构造器详细资料
  - Variable
```
public Variable()
```
    Constructor
  - Variable
```
public Variable(int aNum,
                String aName,
                String aDesc,
                String aUnit)
```
    Constructor
    
    参数:
    
    aNum - Parameter number
    
    aName - The name
    
    aDesc - The description
    
    aUnit - The units
- 方法详细资料
  - getName
```
public String getName()
```
    Get name
    
    返回:
    
    Name
  - getShortName
```
public String getShortName()
```
    Get short name
    
    返回:
    
    Short name
  - setShortName
```
public void setShortName(String value)
```
    Set short name
    
    参数:
    
    value - Short name
  - setName
```
public void setName(String value)
```
    Set name
    
    参数:
    
    value - Name
  - getDataType
```
public org.meteoinfo.ndarray.DataType getDataType()
```
    Get data type
    
    返回:
    
    Data type
  - setDataType
```
public void setDataType(org.meteoinfo.ndarray.DataType value)
```
    Set data type
    
    参数:
    
    value - Data type
  - getDimensions
```
public List<Dimension> getDimensions()
```
    Get dimensions
    
    返回:
    
    Dimensions
  - getDimensions
```
public List<Dimension> getDimensions(org.meteoinfo.ndarray.Section section)
```
    Get dimensions by section
    
    参数:
    
    section - The section
    
    返回:
    
    Result dimesions
  - getDimension
```
public Dimension getDimension(int index)
```
    Get dimension
    
    参数:
    
    index - Dimension index
    
    返回:
    
    Dimension
  - setDimensions
```
public void setDimensions(List<Dimension> dims)
```
    Set dimensions
    
    参数:
    
    dims - Dimensions
  - getAttributes
```
public List<Attribute> getAttributes()
```
    Get attributes
    
    返回:
    
    Attributes
  - getAttribute
```
public Attribute getAttribute(int index)
```
    Get attribute
    
    参数:
    
    index - Attribute index
    
    返回:
    
    Attribute
  - getAddOffset
```
public double getAddOffset()
```
    Get add offset value
    
    返回:
    
    Add offset value
  - setAddOffset
```
public void setAddOffset(double value)
```
    Set add offset value
    
    参数:
    
    value - Add offset value
  - getScaleFactor
```
public double getScaleFactor()
```
    Get scale factor value
    
    返回:
    
    Scale factor value
  - setScaleFactor
```
public void setScaleFactor(double value)
```
    Set scale factor value
    
    参数:
    
    value - Scale factor value
  - getFillValue
```
public double getFillValue()
```
    Get fill value
    
    返回:
    
    Fill value
  - setFillValue
```
public void setFillValue(double value)
```
    Set fill value
    
    参数:
    
    value - Fill value
  - getLevelType
```
public int getLevelType()
```
    Get level type
    
    返回:
    
    Level type
  - setLevelType
```
public void setLevelType(int value)
```
    Set level type
    
    参数:
    
    value - Level type
  - getLevels
```
public List<Double> getLevels()
```
    Get levels
    
    返回:
    
    Levels
  - setLevels
```
public void setLevels(List<Double> value)
```
    Set levels
    
    参数:
    
    value - Levels
  - getUnits
```
public String getUnits()
```
    Set units
    
    返回:
    
    Units
  - setUnits
```
public void setUnits(String value)
```
    Set units
    
    参数:
    
    value - Units
  - getDescription
```
public String getDescription()
```
    Get description
    
    返回:
    
    Description
  - setDescription
```
public void setDescription(String value)
```
    Set description
    
    参数:
    
    value - Description
  - getDimNumber
```
public int getDimNumber()
```
    Get dimension number
    
    返回:
    
    Dimension number
  - getLevelNum
```
public int getLevelNum()
```
    Get level number
    
    返回:
    
    Level number
  - getHDFPath
```
public String getHDFPath()
```
    Get HDF path
    
    返回:
    
    HDF path
  - setHDFPath
```
public void setHDFPath(String value)
```
    Set HDF path
    
    参数:
    
    value - HDF path
  - getXDimension
```
public Dimension getXDimension()
```
    Get X dimension
    
    返回:
    
    X dimension
  - setXDimension
```
public void setXDimension(Dimension value)
```
    Set X dimension
    
    参数:
    
    value - X dimension
  - getYDimension
```
public Dimension getYDimension()
```
    Get Y dimension
    
    返回:
    
    Y dimension
  - setYDimension
```
public void setYDimension(Dimension value)
```
    Set Y dimension
    
    参数:
    
    value - Y dimension
  - getZDimension
```
public Dimension getZDimension()
```
    Get Z dimension
    
    返回:
    
    Z dimension
  - setZDimension
```
public void setZDimension(Dimension value)
```
    Set Z dimension
    
    参数:
    
    value - Z dimension
  - getTDimension
```
public Dimension getTDimension()
```
    Get T dimension
    
    返回:
    
    T dimension
  - setTDimension
```
public void setTDimension(Dimension value)
```
    Set T dimension
    
    参数:
    
    value - T dimension
  - getDimIds
```
public int[] getDimIds()
```
    Get dimension identifers
    
    返回:
    
    Dimension identifers
  - isStation
```
public boolean isStation()
```
    Get if the variable is station data set
    
    返回:
    
    Boolean
  - setStation
```
public void setStation(boolean value)
```
    Set if the variable is station data set
    
    参数:
    
    value - Boolean
  - isSwath
```
public boolean isSwath()
```
    Get if the variable is swath data set
    
    返回:
    
    Boolean
  - setSwath
```
public void setSwath(boolean value)
```
    Set if the variable is swath data set
    
    参数:
    
    value - Boolean
  - isPlottable
```
public boolean isPlottable()
```
    Get if the variable is plottable (has both X and Y dimension)
    
    返回:
    
    Boolean
  - getAttNumber
```
public int getAttNumber()
```
    Get attribute number
    
    返回:
    
    Attribute number
  - getVarId
```
public int getVarId()
```
    Get variable identifer
    
    返回:
    
    Variable identifer
  - setVarId
```
public void setVarId(int value)
```
    Set variable identifer
    
    参数:
    
    value - Variable identifer
  - isDimVar
```
public boolean isDimVar()
```
    Get if the variable is dimension variable
    
    返回:
    
    Boolean
  - setDimVar
```
public void setDimVar(boolean value)
```
    Set if the variable is dimension variable
    
    参数:
    
    value - Boolean
  - isMemberOfStructure
```
public boolean isMemberOfStructure()
```
    Get if the variable is a member of a structure
    
    返回:
    
    Is a member of a structure or not
  - setMemberOfStructure
```
public void setMemberOfStructure(boolean value)
```
    Set if the variable is a member of a structure
    
    参数:
    
    value - Boolean
  - getLevelIdxs
```
public List<Integer> getLevelIdxs()
```
    Get level index list - for ARL data
    
    返回:
    
    Level index list
  - setLevelIdxs
```
public void setLevelIdxs(List<Integer> value)
```
    Set level index list
    
    参数:
    
    value - Level index list
  - getVarInLevelIdxs
```
public List<Integer> getVarInLevelIdxs()
```
    Get variable index in level index list - for ARL data
    
    返回:
    
    Variable index
  - setVarInLevelIdxs
```
public void setVarInLevelIdxs(List<Integer> value)
```
    Set variable index in level index list - for ARL data
    
    参数:
    
    value - Variable index
  - getCachedData
```
public org.meteoinfo.ndarray.Array getCachedData()
```
    Get cached data array
    
    返回:
    
    Cached data array
  - setCachedData
```
public void setCachedData(org.meteoinfo.ndarray.Array value)
```
    Set cached data array
    
    参数:
    
    value - Cached data array
  - hasCachedData
```
public boolean hasCachedData()
```
    Check has cached data or not
    
    返回:
    
    Has cached data or not
  - findAttribute
```
public Attribute findAttribute(String name)
```
    Find an attribute by name
    
    参数:
    
    name - Attribute name
    
    返回:
    
    Attribute
  - findAttributeIgnoreCase
```
public Attribute findAttributeIgnoreCase(String name)
```
    Find an attribute by name ignoring string case
    
    参数:
    
    name - Attribute name
    
    返回:
    
    Attribute
  - clone
```
public Object clone()
```
    Clone
    
    覆盖:
    
    clone 在类中 Object
    
    返回:
    
    Parameter object
  - equals
```
public boolean equals(Variable aVar)
```
    Determine if two parameter are equal
    
    参数:
    
    aVar - The variable
    
    返回:
    
    If equal
  - tEquals
```
public boolean tEquals(Variable aVar)
```
    Determine if two parameter are totally equal
    
    参数:
    
    aVar - The variable
    
    返回:
    
    If equal
  - addLevel
```
public void addLevel(double levelValue)
```
    Add a level
    
    参数:
    
    levelValue - Level value
  - getTrueLevelNumber
```
public int getTrueLevelNumber()
```
    Get true level number
    
    返回:
    
    True level number
  - getDimension
```
public Dimension getDimension(DimensionType dimType)
```
    Get dimension by type
    
    参数:
    
    dimType - Dimension type
    
    返回:
    
    Dimension
  - resetShape
```
public void resetShape()
```
    Use when dimensions have changed, to recalculate the shape.
  - setDimension
```
public void setDimension(String tstr,
                         List<Number> values,
                         boolean reverse)
```
    Set a dimension
    
    参数:
    
    tstr - Dimension type string
    
    values - Dimension values
    
    reverse - If is reverse
  - setDimension
```
public void setDimension(String tstr,
                         List<Number> values,
                         boolean reverse,
                         int index)
```
    Set a dimension
    
    参数:
    
    tstr - Dimension type string
    
    values - Dimension values
    
    index - Index
    
    reverse - If is reverse
  - setDimension
```
public void setDimension(Dimension aDim)
```
    Set dimension
    
    参数:
    
    aDim - The dimension
  - setDimension
```
public void setDimension(int idx,
                         Dimension aDim)
```
    Set dimension
    
    参数:
    
    aDim - The dimension
    
    idx - Index
  - setDimension
```
public void setDimension(Dimension aDim,
                         DimensionType dimType)
```
    Set dimension by dimension type
    
    参数:
    
    aDim - The dimension
    
    dimType - Dimension type
  - getDimIndex
```
public int getDimIndex(Dimension aDim)
```
    Get index of a dimension
    
    参数:
    
    aDim - The dimension
    
    返回:
    
    Index
  - getDimLength
```
public int getDimLength(int idx)
```
    Get dimension length
    
    参数:
    
    idx - Dimension index
    
    返回:
    
    Dimension length
  - hasXtrackDimension
```
public boolean hasXtrackDimension()
```
    Determine if has Xtrack dimension
    
    返回:
    
    Boolean
  - hasDimension
```
public boolean hasDimension(int dimId)
```
    Determine if the variable has a dimension
    
    参数:
    
    dimId - Dimension identifer
    
    返回:
    
    Boolean
  - hasNullDimension
```
public boolean hasNullDimension()
```
    If the variable has a null dimension
    
    返回:
    
    Boolean
  - dimensionEquales
```
public boolean dimensionEquales(Variable var)
```
    If the dimensions equales with another variable
    
    参数:
    
    var - Another variable
    
    返回:
    
    Boolean
  - dimensionSizeEquals
```
public boolean dimensionSizeEquals(Variable var)
```
    If the dimensions size equales with another variable
    
    参数:
    
    var - Another variable
    
    返回:
    
    Boolean
  - dimensionContains
```
public boolean dimensionContains(Variable var)
```
    If the dimensions contains the diemsions of another variable
    
    参数:
    
    var - Another variable
    
    返回:
    
    Boolean
  - getLevelDimension
```
public Dimension getLevelDimension(Variable var)
```
    Get level dimension for SWATH data variable
    
    参数:
    
    var - Variable
    
    返回:
    
    Dimension
  - getTimes
```
public List<LocalDateTime> getTimes()
```
    Get times
    
    返回:
    
    Times
  - getAttributeIndex
```
public int getAttributeIndex(String attName)
```
    Get attribute index by name, return -1 if the name not exist.
    
    参数:
    
    attName - Attribute name
    
    返回:
    
    Attribute index
  - getAttributeString
```
public String getAttributeString(String attName)
```
    Get attribute value string by name
    
    参数:
    
    attName - Attribute name
    
    返回:
    
    Attribute value string
  - addDimension
```
public void addDimension(Dimension dim)
```
    Add a dimension
    
    参数:
    
    dim - Dimension
  - addDimension
```
public void addDimension(int idx,
                         Dimension dim)
```
    Add a dimension
    
    参数:
    
    idx - Index
    
    dim - Dimension
  - addDimension
```
public void addDimension(DimensionType dType,
                         List<Number> values)
```
    Add a dimension
    
    参数:
    
    dType - Dimension type
    
    values - Dimension values
  - addDimension
```
public void addDimension(String tstr,
                         List<Number> values)
```
    Add a dimension
    
    参数:
    
    tstr - Dimension type string
    
    values - Dimension values
  - getStaggerDimIndex
```
public int getStaggerDimIndex()
```
    Get stagger dimension index
    
    返回:
    
    Stagger dimension index
  - addAttribute
```
public void addAttribute(Attribute attr)
```
    Add an attribute
    
    参数:
    
    attr - Attribute
  - addAttribute
```
public void addAttribute(String attName,
                         List attValue)
```
    Add attribute
    
    参数:
    
    attName - Attribute name
    
    attValue - Attribute value
  - addAttribute
```
public void addAttribute(String attName,
                         String attValue)
```
    Add attribute
    
    参数:
    
    attName - Attribute name
    
    attValue - Attribute value
  - addAttribute
```
public void addAttribute(String attName,
                         double attValue)
```
    Add attribute
    
    参数:
    
    attName - Attribute name
    
    attValue - Attribute name
  - updateZDimension
```
public void updateZDimension()
```
    Update z dimension from levels
  - sectionDimensions
```
public List<Dimension> sectionDimensions(int[] origin,
                                         int[] size,
                                         int[] stride)
                                  throws org.meteoinfo.ndarray.InvalidRangeException
```
    Section dimensions
    
    参数:
    
    origin - Origin
    
    size - Size
    
    stride - Stride
    
    返回:
    
    Section result dimensions
    
    抛出:
    
    org.meteoinfo.ndarray.InvalidRangeException
  - toString
```
public String toString()
```
    To string
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    String

构造器	说明
`Variable()`	Constructor
`Variable(int aNum, String aName, String aDesc, String aUnit)`	Constructor

类 Variable

字段概要

构造器概要

方法概要

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

字段详细资料

Number

shape

dimensions

attributes

addOffset

scaleFactor

fillValue

构造器详细资料

Variable

Variable

方法详细资料

getName

getShortName

setShortName

setName

getDataType

setDataType

getDimensions

getDimensions

getDimension

setDimensions

getAttributes

getAttribute

getAddOffset

setAddOffset

getScaleFactor

setScaleFactor

getFillValue

setFillValue

getLevelType

setLevelType

getLevels

setLevels

getUnits

setUnits

getDescription

setDescription

getDimNumber

getLevelNum

getHDFPath

setHDFPath

getXDimension

setXDimension

getYDimension

setYDimension

getZDimension

setZDimension

getTDimension

setTDimension

getDimIds

isStation

setStation

isSwath

setSwath

isPlottable

getAttNumber

getVarId

setVarId

isDimVar

setDimVar

isMemberOfStructure

setMemberOfStructure

getLevelIdxs

setLevelIdxs

getVarInLevelIdxs

setVarInLevelIdxs

getCachedData

setCachedData

hasCachedData

findAttribute

findAttributeIgnoreCase

clone

equals

tEquals