类 Variable

  • 所有已实现的接口:
    java.lang.Comparable<ucar.nc2.VariableSimpleIF>, ucar.nc2.AttributeContainer, ucar.nc2.ProxyReader, ucar.nc2.VariableIF, ucar.nc2.VariableSimpleIF

    public class Variable
    extends ucar.nc2.Variable
    作者:
    Yaqiang Wang
    • 嵌套类概要

      • 从类继承的嵌套类/接口 ucar.nc2.Variable

        ucar.nc2.Variable.Cache
    • 字段概要

      字段 
      修饰符和类型 字段 说明
      int Number  
      • 从类继承的字段 ucar.nc2.Variable

        attributes, cache, dataType, debugCaching, defaultCoordsSizeToCache, defaultSizeToCache, dimensions, elementSize, hashCode, isMetadata, isVariableLength, ncfile, permitCaching, proxyReader, shape, shapeAsSection, sizeToCache, spiObject
      • 从类继承的字段 ucar.nc2.CDMNode

        annotations, dodsname, group, immutable, parentstruct, shortName, sort
    • 构造器概要

      构造器 
      构造器 说明
      Variable()
      Constructor
      Variable​(int aNum, java.lang.String aName, java.lang.String aDesc, java.lang.String aUnit)
      Constructor
      Variable​(ucar.nc2.Variable from)
      Construct
    • 方法概要

      所有方法 实例方法 具体方法 
      修饰符和类型 方法 说明
      void addAttribute​(java.lang.String attName, double attValue)
      Add attribute
      void addAttribute​(java.lang.String attName, java.lang.String attValue)
      Add attribute
      void addAttribute​(java.lang.String attName, java.util.List attValue)
      Add attribute
      void addDimension​(int idx, Dimension dim)
      Add a dimension
      void addDimension​(java.lang.String tstr, java.util.List<java.lang.Number> values)
      Add a dimension
      void addDimension​(Dimension dim)
      Add a dimension
      void addDimension​(DimensionType dType, java.util.List<java.lang.Number> values)
      Add a dimension
      void addLevel​(double levelValue)
      Add a level
      java.lang.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
      double getAddOffset()
      Get add offset
      int getAttNumber()
      Get attribute number
      int getAttributeIndex​(java.lang.String attName)
      Get attribute index by name, return -1 if the name not exist.
      java.lang.String getAttributeString​(java.lang.String attName)
      Get attribute value string by name
      java.lang.String getDescription()
      Get description
      Dimension getDimension​(DimensionType dimType)
      Get dimension by type
      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
      java.lang.String getHDFPath()
      Get HDF path
      Dimension getLevelDimension​(Variable var)
      Get level dimension for SWATH data variable
      java.util.List<java.lang.Integer> getLevelIdxs()
      Get level index list - for ARL data
      int getLevelNum()
      Get level number
      java.util.List<java.lang.Double> getLevels()
      Get levels
      int getLevelType()
      Get level type
      java.lang.String getName()
      Get name
      double getScaleFactor()
      Get scale factor
      Dimension getTDimension()
      Get T dimension
      java.util.List<java.util.Date> getTimes()
      Get times
      int getTrueLevelNumber()
      Get true level number
      java.lang.String getUnits()
      Set units
      int getVarId()
      Get variable identifer
      java.util.List<java.lang.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 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 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 setAddOffset​(double value)
      Set add offset
      void setDescription​(java.lang.String value)
      Set description
      void setDimension​(java.lang.String tstr, java.util.List<java.lang.Number> values, boolean reverse)
      Set a dimension
      void setDimension​(java.lang.String tstr, java.util.List<java.lang.Number> values, boolean reverse, int index)
      Set a dimension
      void setDimension​(Dimension aDim)
      Set dimension
      void setDimension​(Dimension aDim, int idx)
      Set dimension
      void setDimension​(Dimension aDim, DimensionType dimType)
      Set dimension by dimension type
      void setDimVar​(boolean value)
      Set if the variable is dimension variable
      void setFillValue​(double value)
      Set fill value
      void setHDFPath​(java.lang.String value)
      Set HDF path
      void setLevelIdxs​(java.util.List<java.lang.Integer> value)
      Set level index list
      void setLevels​(java.util.List<java.lang.Double> value)
      Set levels
      void setLevelType​(int value)
      Set level type
      java.lang.String setName​(java.lang.String value)
      Set name
      void setScaleFactor​(double value)
      Set scale factor
      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​(java.lang.String value)
      Set units
      void setVarId​(int value)
      Set variable identifer
      void setVarInLevelIdxs​(java.util.List<java.lang.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
      java.util.List<ucar.nc2.Dimension> toNCDimensions()
      To netCDF dimensions
      void updateZDimension()
      Update z dimension from levels
      • 从类继承的方法 ucar.nc2.Variable

        _read, _read, addAll, addAttribute, compareTo, copy, createNewCache, equals, extraInfo, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDAPName, getDAPName, getDatasetLocation, getDataType, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getElementSize, getEnumTypedef, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNetcdfFile, getParentGroup, getProxyReader, getRanges, getRank, getScalarData, getShape, getShape, getShapeAll, getShapeAsSection, getShapeNotScalar, getSize, getSizeToCache, getSPobject, getUnitsString, hasCachedData, hashCode, hashCodeShow, invalidateCache, isCaching, isCoordinateVariable, isImmutable, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, readToStream, reallyRead, reallyRead, reduce, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setCaching, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setImmutable, setIsScalar, setParentGroup, setProxyReader, setSizeToCache, setSPobject, setUnsigned, setValues, setValues, slice, toString, toStringDebug, writeCDL, writeCDL
      • 从类继承的方法 ucar.nc2.CDMNode

        annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getGroup, getImmutable, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentStructure, setShortName, setSort, unwrap
      • 从类继承的方法 java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • 从接口继承的方法 ucar.nc2.VariableIF

        getFullName, getFullNameEscaped, getParentStructure, getShortName, isMemberOfStructure
    • 字段详细资料

      • Number

        public int Number
    • 构造器详细资料

      • Variable

        public Variable()
        Constructor
      • Variable

        public Variable​(ucar.nc2.Variable from)
        Construct
        参数:
        from - From variable
      • Variable

        public Variable​(int aNum,
                        java.lang.String aName,
                        java.lang.String aDesc,
                        java.lang.String aUnit)
        Constructor
        参数:
        aNum - Parameter number
        aName - The name
        aDesc - The description
        aUnit - The units
    • 方法详细资料

      • getName

        public java.lang.String getName()
        Get name
        指定者:
        getName 在接口中 ucar.nc2.VariableSimpleIF
        覆盖:
        getName 在类中 ucar.nc2.CDMNode
        返回:
        Name
      • setName

        public java.lang.String setName​(java.lang.String value)
        Set name
        覆盖:
        setName 在类中 ucar.nc2.Variable
        参数:
        value - Name
        返回:
      • getLevelType

        public int getLevelType()
        Get level type
        返回:
        Level type
      • setLevelType

        public void setLevelType​(int value)
        Set level type
        参数:
        value - Level type
      • getLevels

        public java.util.List<java.lang.Double> getLevels()
        Get levels
        返回:
        Levels
      • setLevels

        public void setLevels​(java.util.List<java.lang.Double> value)
        Set levels
        参数:
        value - Levels
      • getUnits

        public java.lang.String getUnits()
        Set units
        返回:
        Units
      • setUnits

        public void setUnits​(java.lang.String value)
        Set units
        参数:
        value - Units
      • getDescription

        public java.lang.String getDescription()
        Get description
        指定者:
        getDescription 在接口中 ucar.nc2.VariableIF
        指定者:
        getDescription 在接口中 ucar.nc2.VariableSimpleIF
        覆盖:
        getDescription 在类中 ucar.nc2.Variable
        返回:
        Description
      • setDescription

        public void setDescription​(java.lang.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 java.lang.String getHDFPath()
        Get HDF path
        返回:
        HDF path
      • setHDFPath

        public void setHDFPath​(java.lang.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
      • getLevelIdxs

        public java.util.List<java.lang.Integer> getLevelIdxs()
        Get level index list - for ARL data
        返回:
        Level index list
      • setLevelIdxs

        public void setLevelIdxs​(java.util.List<java.lang.Integer> value)
        Set level index list
        参数:
        value - Level index list
      • getVarInLevelIdxs

        public java.util.List<java.lang.Integer> getVarInLevelIdxs()
        Get variable index in level index list - for ARL data
        返回:
        Variable index
      • setVarInLevelIdxs

        public void setVarInLevelIdxs​(java.util.List<java.lang.Integer> value)
        Set variable index in level index list - for ARL data
        参数:
        value - Variable index
      • getFillValue

        public double getFillValue()
        Get fill value
        返回:
        Fill value
      • setFillValue

        public void setFillValue​(double value)
        Set fill value
        参数:
        value - Fill value
      • getScaleFactor

        public double getScaleFactor()
        Get scale factor
        返回:
        Scale factor
      • setScaleFactor

        public void setScaleFactor​(double value)
        Set scale factor
        参数:
        value - Scale factor
      • getAddOffset

        public double getAddOffset()
        Get add offset
        返回:
        Add offset
      • setAddOffset

        public void setAddOffset​(double value)
        Set add offset
        参数:
        value - Add offset
      • clone

        public java.lang.Object clone()
        Clone
        覆盖:
        clone 在类中 java.lang.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
      • setDimension

        public void setDimension​(java.lang.String tstr,
                                 java.util.List<java.lang.Number> values,
                                 boolean reverse)
        Set a dimension
        参数:
        tstr - Dimension type string
        values - Dimension values
        reverse - If is reverse
      • setDimension

        public void setDimension​(java.lang.String tstr,
                                 java.util.List<java.lang.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​(Dimension aDim,
                                 int idx)
        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 java.util.List<java.util.Date> getTimes()
        Get times
        返回:
        Times
      • getAttributeIndex

        public int getAttributeIndex​(java.lang.String attName)
        Get attribute index by name, return -1 if the name not exist.
        参数:
        attName - Attribute name
        返回:
        Attribute index
      • getAttributeString

        public java.lang.String getAttributeString​(java.lang.String attName)
        Get attribute value string by name
        参数:
        attName - Attribute name
        返回:
        Attribute value string
      • toNCDimensions

        public java.util.List<ucar.nc2.Dimension> toNCDimensions()
        To netCDF dimensions
        返回:
        NC dimensions
      • 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,
                                 java.util.List<java.lang.Number> values)
        Add a dimension
        参数:
        dType - Dimension type
        values - Dimension values
      • addDimension

        public void addDimension​(java.lang.String tstr,
                                 java.util.List<java.lang.Number> values)
        Add a dimension
        参数:
        tstr - Dimension type string
        values - Dimension values
      • addAttribute

        public void addAttribute​(java.lang.String attName,
                                 java.util.List attValue)
        Add attribute
        参数:
        attName - Attribute name
        attValue - Attribute value
      • addAttribute

        public void addAttribute​(java.lang.String attName,
                                 java.lang.String attValue)
        Add attribute
        参数:
        attName - Attribute name
        attValue - Attribute value
      • addAttribute

        public void addAttribute​(java.lang.String attName,
                                 double attValue)
        Add attribute
        参数:
        attName - Attribute name
        attValue - Attribute name
      • updateZDimension

        public void updateZDimension()
        Update z dimension from levels