Class Dimension



  • public class Dimension
    extends ucar.nc2.Dimension
    Template
    • Field Summary

      • Fields inherited from class ucar.nc2.CDMNode

        annotations, dodsname, group, immutable, parentstruct, shortName, sort
      • Fields inherited from class ucar.nc2.Dimension

        VLEN
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addValue​(double value)
      Add a dimension value
      boolean equals​(Dimension aDim)
      Determine if two dimensions equals
      Dimension extract​(double first, double last, double stride)
      Extract dimension
      Dimension extract​(int first, int last, int stride)
      Extract dimension
      Dimension extract​(java.util.List<java.lang.Integer> index)
      Extract dimension
      double getDeltaValue​()
      Get delta value
      int getDimId​()
      Get dimension identifer
      DimensionType getDimType​()
      Get dimension type
      java.util.List<java.lang.Double> getDimValue​()
      Get dimension values
      double getMaxValue​()
      Get maximum dimension value
      double getMinValue​()
      Get minimum dimension value
      int getValueIndex​(double v)
      Get value index
      double[] getValues​()
      Get dimension value array
      boolean isReverse​()
      Get if values are reverse (in descending order)
      void setDimId​(int value)  
      void setDimLength​(int value)
      Set dimension length
      void setDimType​(DimensionType value)
      Set dimension type
      void setDimValues​(java.util.List<java.lang.Number> values)
      Set dimension values
      void setLength​(int value)
      Set dimension length
      void setReverse​(boolean value)
      Set if values are reverse
      void setValues​(double[] values)
      Set dimension values
      void setValues​(float[] values)
      Set dimension values
      void setValues​(java.util.List<java.lang.Double> values)
      Set dimension values
      java.lang.String toString​()  
      • Methods inherited from class ucar.nc2.CDMNode

        annotate, getAnnotation, getAnnotations, getDODSName, getFullName, getFullNameEscaped, getImmutable, getName, getParentGroup, getParentStructure, getShortName, getSort, isMemberOfStructure, localhash, setDODSName, setImmutable, setParentGroup, setParentStructure, setShortName, setSort, unwrap
      • Methods inherited from class ucar.nc2.Dimension

        compareTo, equals, getGroup, getLength, hashCode, hashCodeShow, isShared, isUnlimited, isVariableLength, makeDimensionsAnon, makeDimensionsList, makeDimensionsString, makeFullName, setGroup, setImmutable, setName, setShared, setUnlimited, setVariableLength, writeCDL, writeCDL
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Dimension

        public Dimension​()
        Constructor
      • Dimension

        public Dimension​(ucar.nc2.Dimension dim)
        Constructor
        Parameters:
        dim - Other dimension
      • Dimension

        public Dimension​(ucar.nc2.Dimension dim,
                         DimensionType dimType)
        Constructor
        Parameters:
        dim - Other dimension
        dimType - Dimension type
      • Dimension

        public Dimension​(java.lang.String name,
                         int len)
        Constructor
        Parameters:
        name - Name
        len - Length
      • Dimension

        public Dimension​(DimensionType dimType)
        Constructor
        Parameters:
        dimType - Dimension type
      • Dimension

        public Dimension​(java.lang.String name,
                         int len,
                         DimensionType dimType)
        Constructor
        Parameters:
        name - Name
        len - Length
        dimType - Dimension type
      • Dimension

        public Dimension​(java.lang.String name,
                         int len,
                         DimensionType dimType,
                         double min,
                         double delta,
                         int num)
        Constructor
        Parameters:
        name - Name
        len - Length
        dimType - Dimension type
        min - Minimum value
        delta - Delta value
        num - value number
    • Method Detail

      • setDimLength

        public void setDimLength​(int value)
        Set dimension length
        Parameters:
        value - Dimension length
      • setLength

        public void setLength​(int value)
        Set dimension length
        Overrides:
        setLength in class ucar.nc2.Dimension
        Parameters:
        value - Dimension length
      • getDimType

        public DimensionType getDimType​()
        Get dimension type
        Returns:
        Dimension type
      • setDimType

        public void setDimType​(DimensionType value)
        Set dimension type
        Parameters:
        value - Dimension type
      • getDimValue

        public java.util.List<java.lang.Double> getDimValue​()
        Get dimension values
        Returns:
        Dimension values
      • getDimId

        public int getDimId​()
        Get dimension identifer
        Returns:
        Dimension identifer
      • setDimId

        public void setDimId​(int value)
      • isReverse

        public boolean isReverse​()
        Get if values are reverse (in descending order)
        Returns:
        Boolean
      • setReverse

        public void setReverse​(boolean value)
        Set if values are reverse
        Parameters:
        value - Boolean
      • equals

        public boolean equals​(Dimension aDim)
        Determine if two dimensions equals
        Parameters:
        aDim - The other dimension
        Returns:
        If equals
      • getValues

        public double[] getValues​()
        Get dimension value array
        Returns:
        Value array
      • setValues

        public void setValues​(java.util.List<java.lang.Double> values)
        Set dimension values
        Parameters:
        values - Values
      • setDimValues

        public void setDimValues​(java.util.List<java.lang.Number> values)
        Set dimension values
        Parameters:
        values - Values
      • setValues

        public void setValues​(double[] values)
        Set dimension values
        Parameters:
        values - Values
      • setValues

        public void setValues​(float[] values)
        Set dimension values
        Parameters:
        values - Values
      • addValue

        public void addValue​(double value)
        Add a dimension value
        Parameters:
        value - The value
      • getMinValue

        public double getMinValue​()
        Get minimum dimension value
        Returns:
        Minimum dimension value
      • getMaxValue

        public double getMaxValue​()
        Get maximum dimension value
        Returns:
        Maximum dimension value
      • getDeltaValue

        public double getDeltaValue​()
        Get delta value
        Returns:
        Delta value
      • extract

        public Dimension extract​(int first,
                                 int last,
                                 int stride)
        Extract dimension
        Parameters:
        first - First
        last - Last
        stride - Stride
        Returns:
        Extracted dimension
      • extract

        public Dimension extract​(double first,
                                 double last,
                                 double stride)
        Extract dimension
        Parameters:
        first - First
        last - Last
        stride - Stride
        Returns:
        Extracted dimension
      • extract

        public Dimension extract​(java.util.List<java.lang.Integer> index)
        Extract dimension
        Parameters:
        index - Indices
        Returns:
        Extracted dimension
      • getValueIndex

        public int getValueIndex​(double v)
        Get value index
        Parameters:
        v - Value
        Returns:
        Index
      • toString

        public java.lang.String toString​()
        Overrides:
        toString in class ucar.nc2.Dimension