VariableDS (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.Variable
- - ucar.nc2.dataset.VariableDS

All Implemented Interfaces:

Comparable<VariableSimpleIF>, IsMissingEvaluator, EnhanceScaleMissingUnsigned, VariableEnhanced, ProxyReader, VariableSimpleIF

Direct Known Subclasses:

CoordinateAxis
```
public class VariableDS
extends Variable
implements EnhanceScaleMissingUnsigned, VariableEnhanced
```
A wrapper around a Variable, creating an "enhanced" Variable. The original Variable is used for the I/O. There are several distinct uses:
1. Handle scale/offset/missing/enum/unsigned conversion; this can change DataType and data values
2. Container for coordinate system information
3. NcML modifications to underlying Variable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VariableDS.Builder<T extends VariableDS.Builder<T>>
- Nested classes/interfaces inherited from class ucar.nc2.Variable
  Variable.Cache

Nested Classes
Modifier and Type	Class and Description
`static class`	`VariableDS.Builder<T extends VariableDS.Builder<T>>`

Field Summary

Fields
Modifier and Type Field and Description

protected ArrayType orgDataType

protected String orgName

protected Variable orgVar
- Fields inherited from class ucar.nc2.Variable
  attributes, cache, dataType, dimensions, elementSize, hashCode, isVariableLength, ncfile, permitCaching, proxyReader, shape, spiObject

Fields
Modifier and Type	Field and Description
`protected ArrayType`	`orgDataType`
`protected String`	`orgName`
`protected Variable`	`orgVar`

Constructor Summary

Constructors
Modifier Constructor and Description

protected VariableDS(VariableDS.Builder<?> builder, Group parentGroup)

Constructors
Modifier	Constructor and Description
`protected`	`VariableDS(VariableDS.Builder<?> builder, Group parentGroup)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Array`	`_read()` Deprecated.
`protected Array`	`_read(Section section)` Deprecated.
`protected VariableDS.Builder<?>`	`addLocalFieldsToBuilder(VariableDS.Builder<? extends VariableDS.Builder<?>> builder)`
`Array`	`applyScaleOffset(Array data)` Deprecated. do not use
`double`	`applyScaleOffset(Number value)` Deprecated. do not use
`static VariableDS.Builder<?>`	`builder()` Get Builder for this class that allows subclassing.
`Array`	`convert(Array in, boolean convertUnsigned, boolean applyScaleOffset, boolean convertMissing)` Deprecated. do not use
`Array<?>`	`convertArray(Array<?> data)` Convert the data using the VariableDS enhancements.
`Array`	`convertMissing(Array in)` Deprecated. do not use
`Number`	`convertMissing(Number value)` Deprecated. do not use
`boolean`	`convertNeeded()` Does data need to be converted?
`Array`	`convertUnsigned(Array in)` Deprecated. do not use
`Number`	`convertUnsigned(Number value)` Deprecated. do not use
`static VariableDS`	`fromVar(Group group, Variable orgVar, boolean enhance)` Create a VariableDS from orgVar, with default enhancements if requested.
`com.google.common.collect.ImmutableList<CoordinateSystem>`	`getCoordinateSystems()` Get the list of Coordinate Systems for this Variable, larger number of axes first.
`String`	`getDatasetLocation()` The location of the dataset this belongs to.
`String`	`getDescription()` Get the description of the Variable.
`Set<NetcdfDataset.Enhance>`	`getEnhanceMode()` Returns the enhancements applied to this variable.
`double`	`getFillValue()` Deprecated. do not use
`Array`	`getMissingDataArray(int[] shape)` Deprecated. use Arrays.getMissingDataArray()
`double[]`	`getMissingValues()` Deprecated. do not use
`NetcdfFile`	`getNetcdfFile()` Get the NetcdfFile that this variable is contained in.
`double`	`getOffset()` Deprecated. do not use
`ArrayType`	`getOriginalArrayType()` When this wraps another Variable, get the original Variable's ArrayType.
`DataType`	`getOriginalDataType()` Deprecated. use getOriginalArrayType()
`String`	`getOriginalName()` When this wraps another Variable, get the original Variable's name.
`Variable`	`getOriginalVariable()` A VariableDS usually wraps another Variable.
`DataType`	`getScaledOffsetType()` Deprecated. do not use
`double`	`getScaleFactor()` Deprecated. do not use
`DataType.Signedness`	`getSignedness()` Deprecated. do not use
`String`	`getUnitsString()` Get the Unit String for the Variable.
`DataType`	`getUnsignedConversionType()` Deprecated. do not use
`double`	`getValidMax()` Deprecated. do not use
`double`	`getValidMin()` Deprecated. do not use
`boolean`	`hasFillValue()` Deprecated. do not use
`boolean`	`hasMissing()` Deprecated. do not use
`boolean`	`hasMissingValue()` Deprecated. do not use
`boolean`	`hasScaleOffset()` Deprecated. do not use
`boolean`	`hasValidData()` true if Variable has valid_range, valid_min or valid_max attributes
`boolean`	`isFillValue(double val)` Deprecated. do not use
`boolean`	`isInvalidData(double val)` Deprecated. do not use
`boolean`	`isMissing(double val)` Deprecated. do not use
`boolean`	`isMissingValue(double val)` Deprecated. do not use
`String`	`lookupEnumString(int val)` Lookup the enum string for this value.
`Array<?>`	`proxyReadArray(Variable client, CancelTask cancelTask)` public by accident, do not call directly.
`Array<?>`	`proxyReadArray(Variable client, Section section, CancelTask cancelTask)` public by accident, do not call directly.
`Array<?>`	`readArray()` Read all the data for this Variable and return a memory resident Array.
`Array<?>`	`readArray(Section section)` Read a section of the data for this Variable from the netcdf file and return a memory resident Array.
`long`	`readToStream(Section section, OutputStream out)` Deprecated.
`Array`	`reallyRead(Variable client, CancelTask cancelTask)` Deprecated.
`Array`	`reallyRead(Variable client, Section section, CancelTask cancelTask)` Deprecated.
`void`	`setCaching(boolean caching)` Set whether to cache or not.
`void`	`showScaleMissingProxy(Formatter f)` Deprecated. use Arrays.getMissingDataArray()
`VariableDS.Builder<?>`	`toBuilder()` Turn into a mutable Builder.
`String`	`toString()`
`String`	`toStringDebug()` Debugging info

Methods inherited from class ucar.nc2.Variable
_readScalarData, addLocalFieldsToBuilder, attributes, compareTo, equals, extraInfo, findAttribute, findAttributeString, findDimensionIndex, getArrayType, getDataType, getDimension, getDimensions, getDimensionSet, getDimensionsString, getElementSize, getEnumTypedef, getFileTypeId, getFullName, getNameAndDimensions, getNameAndDimensions, getParentGroup, getParentStructure, getRanges, getRank, getSection, getShape, getShape, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, hasCachedData, hashCode, invalidateCache, isCaching, isCoordinateVariable, isMemberOfStructure, isMetadata, isScalar, isUnlimited, isVariableLength, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, reduce, resetShape, section, section, setCachedData, slice, writeCDL

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced
getFullName, getParentGroup, getShortName

- Field Detail
  - orgVar
```
@Nullable
protected final Variable orgVar
```
  - orgDataType
```
protected final ArrayType orgDataType
```
  - orgName
```
@Nullable
protected final String orgName
```
- Constructor Detail
  - VariableDS
```
protected VariableDS(VariableDS.Builder<?> builder,
                     Group parentGroup)
```
- Method Detail
  - fromVar
```
public static VariableDS fromVar(Group group,
                                 Variable orgVar,
                                 boolean enhance)
```
    Create a VariableDS from orgVar, with default enhancements if requested.
    
    Parameters:
    
    group - Reparent to this Group.
    
    orgVar - Wrap this Variable.
    
    enhance - opriona default enhancements.
  - getNetcdfFile
```
public NetcdfFile getNetcdfFile()
```
    Description copied from class: Variable
    
    Get the NetcdfFile that this variable is contained in. May be null when the Variable is self contained.
    
    Overrides:
    
    getNetcdfFile in class Variable
  - convertNeeded
```
public boolean convertNeeded()
```
    Does data need to be converted?
  - convertArray
```
public Array<?> convertArray(Array<?> data)
```
    Convert the data using the VariableDS enhancements. Generally the user does not have to call this.
  - getEnhanceMode
```
public Set<NetcdfDataset.Enhance> getEnhanceMode()
```
    Returns the enhancements applied to this variable. If this variable wraps another variable, the returned set will also contain the enhancements applied to the nested variable, recursively.
    
    Returns:
    
    the enhancements applied to this variable.
  - getOriginalVariable
```
@Nullable
public Variable getOriginalVariable()
```
    A VariableDS usually wraps another Variable.
    
    Specified by:
    
    getOriginalVariable in interface VariableEnhanced
  - getOriginalDataType
```
public DataType getOriginalDataType()
```
    Deprecated. use getOriginalArrayType()
  - getOriginalArrayType
```
public ArrayType getOriginalArrayType()
```
    When this wraps another Variable, get the original Variable's ArrayType.
    
    Returns:
    
    original Variable's ArrayType, or current data type if it doesnt wrap another variable
  - getOriginalName
```
@Nullable
public String getOriginalName()
```
    When this wraps another Variable, get the original Variable's name.
    
    Specified by:
    
    getOriginalName in interface VariableEnhanced
    
    Returns:
    
    original Variable's name, or null.
  - lookupEnumString
```
public String lookupEnumString(int val)
```
    Description copied from class: Variable
    
    Lookup the enum string for this value. Can only be called on enum types, where dataType.isEnum() is true.
    
    Overrides:
    
    lookupEnumString in class Variable
    
    Parameters:
    
    val - the integer value of this enum
    
    Returns:
    
    the String value, or null if not exist.
  - toStringDebug
```
public String toStringDebug()
```
    Description copied from class: Variable
    
    Debugging info
    
    Overrides:
    
    toStringDebug in class Variable
  - getDatasetLocation
```
public String getDatasetLocation()
```
    Description copied from class: Variable
    
    The location of the dataset this belongs to. Labeling purposes only.
    
    Overrides:
    
    getDatasetLocation in class Variable
  - setCaching
```
public void setCaching(boolean caching)
```
    Description copied from class: Variable
    
    Set whether to cache or not. Implies that the entire array will be stored, once read. Normally this is set automatically based on size of data. if false, cachedData is cleared.
    
    Overrides:
    
    setCaching in class Variable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Variable
  - _read
```
@Deprecated
protected Array _read()
                            throws IOException
```
    Deprecated.
    
    Overrides:
    
    _read in class Variable
    
    Throws:
    
    IOException
  - readArray
```
public Array<?> readArray()
                   throws IOException
```
    Description copied from class: Variable
    
    Read all the data for this Variable and return a memory resident Array. The Array has the same element type and shape as the Variable.
    
    Overrides:
    
    readArray in class Variable
    
    Throws:
    
    IOException
  - reallyRead
```
@Deprecated
public Array reallyRead(Variable client,
                                     CancelTask cancelTask)
                              throws IOException
```
    Deprecated.
    
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Overrides:
    
    reallyRead in class Variable
    
    Parameters:
    
    client - the client Variable
    
    cancelTask - user may cancel
    
    Returns:
    
    memory resident Array containing the data. Will have same shape as the Variable.
    
    Throws:
    
    IOException
  - proxyReadArray
```
public Array<?> proxyReadArray(Variable client,
                               CancelTask cancelTask)
                        throws IOException
```
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    proxyReadArray in interface ProxyReader
    
    Overrides:
    
    proxyReadArray in class Variable
    
    Throws:
    
    IOException
  - _read
```
@Deprecated
protected Array _read(Section section)
                            throws IOException,
                                   InvalidRangeException
```
    Deprecated.
    
    Overrides:
    
    _read in class Variable
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - reallyRead
```
@Deprecated
public Array reallyRead(Variable client,
                                     Section section,
                                     CancelTask cancelTask)
                              throws IOException,
                                     InvalidRangeException
```
    Deprecated.
    
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    reallyRead in interface ProxyReader
    
    Overrides:
    
    reallyRead in class Variable
    
    Parameters:
    
    client - the client Variable
    
    section - the section of data to read.
    
    cancelTask - user may cancel
    
    Returns:
    
    memory resident Array containing the data. Will have same shape as the Section.
    
    Throws:
    
    InvalidRangeException - if section has incorrect rank or illegal shape.
    
    IOException
  - readArray
```
public Array<?> readArray(Section section)
                   throws IOException,
                          InvalidRangeException
```
    Description copied from class: Variable
    
    Read a section of the data for this Variable from the netcdf file and return a memory resident Array. The Array has the same element type as the Variable, and the requested shape. Note that this does not do rank reduction, so the returned Array has the same rank as the Variable. Use Array.reduce() for rank reduction.
    
    Overrides:
    
    readArray in class Variable
    
    Parameters:
    
    section - The section of data to read. Must be null or same rank as variable. If list is null, assume all data. Each Range corresponds to a Dimension. If the Range object is null, it means use the entire dimension.
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - proxyReadArray
```
public Array<?> proxyReadArray(Variable client,
                               Section section,
                               CancelTask cancelTask)
                        throws IOException,
                               InvalidRangeException
```
    Description copied from class: Variable
    
    public by accident, do not call directly.
    
    Specified by:
    
    proxyReadArray in interface ProxyReader
    
    Overrides:
    
    proxyReadArray in class Variable
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - readToStream
```
@Deprecated
public long readToStream(Section section,
                                      OutputStream out)
                               throws IOException,
                                      InvalidRangeException
```
    Deprecated.
    
    Overrides:
    
    readToStream in class Variable
    
    Throws:
    
    IOException
    
    InvalidRangeException
  - getMissingDataArray
```
@Deprecated
public Array getMissingDataArray(int[] shape)
```
    Deprecated. use Arrays.getMissingDataArray()
    
    Return Array with missing data
    
    Parameters:
    
    shape - of this shape
    
    Returns:
    
    Array with given shape
  - showScaleMissingProxy
```
@Deprecated
public void showScaleMissingProxy(Formatter f)
```
    Deprecated. use Arrays.getMissingDataArray()
    
    public for debugging
    
    Parameters:
    
    f - put info here
  - getDescription
```
public String getDescription()
```
    Description copied from class: Variable
    
    Get the description of the Variable. Default is to use CDM.LONG_NAME attribute value. If not exist, look for "description", "title", or "standard_name" attribute value (in that order).
    
    Specified by:
    
    getDescription in interface VariableEnhanced
    
    Specified by:
    
    getDescription in interface VariableSimpleIF
    
    Overrides:
    
    getDescription in class Variable
    
    Returns:
    
    description, or null if not found.
  - getUnitsString
```
public String getUnitsString()
```
    Description copied from class: Variable
    
    Get the Unit String for the Variable. Looks for the CDM.UNITS attribute value
    
    Specified by:
    
    getUnitsString in interface VariableEnhanced
    
    Specified by:
    
    getUnitsString in interface VariableSimpleIF
    
    Overrides:
    
    getUnitsString in class Variable
    
    Returns:
    
    unit string, or null if not found.
  - getCoordinateSystems
```
public com.google.common.collect.ImmutableList<CoordinateSystem> getCoordinateSystems()
```
    Description copied from interface: VariableEnhanced
    
    Get the list of Coordinate Systems for this Variable, larger number of axes first.
    
    Specified by:
    
    getCoordinateSystems in interface VariableEnhanced
  - hasScaleOffset
```
@Deprecated
public boolean hasScaleOffset()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable data will be converted using scale and offset
    
    Specified by:
    
    hasScaleOffset in interface EnhanceScaleMissingUnsigned
  - getScaleFactor
```
@Deprecated
public double getScaleFactor()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    The data are to be multiplied by this value after the data are read. By default it is 1.0, i.e. no scaling. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.
    
    Specified by:
    
    getScaleFactor in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the multiplier to apply to the data.
  - getOffset
```
@Deprecated
public double getOffset()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    The number to be added to the data after it is read. If both CDM.SCALE_FACTOR and CDM.ADD_OFFSET attributes are present, the data are first scaled before the offset is added. By default it is 0.0, i.e. no offset. It will remain that value if the variable defines no CDM.SCALE_FACTOR attribute.
    
    Specified by:
    
    getOffset in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the number to add to the data.
  - hasMissing
```
@Deprecated
public boolean hasMissing()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has missing data values
    
    Specified by:
    
    hasMissing in interface IsMissingEvaluator
    
    Specified by:
    
    hasMissing in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    true if Variable has missing data values
  - isMissing
```
@Deprecated
public boolean isMissing(double val)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns true if the argument is a missing value. Note that Float.NaN and Double.NaN are considered missing data.
    
    Specified by:
    
    isMissing in interface IsMissingEvaluator
    
    Specified by:
    
    isMissing in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    val - an unpacked value.
    
    Returns:
    
    true if the argument is a missing value.
  - hasValidData
```
public boolean hasValidData()
```
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has valid_range, valid_min or valid_max attributes
    
    Specified by:
    
    hasValidData in interface EnhanceScaleMissingUnsigned
  - getValidMin
```
@Deprecated
public double getValidMin()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return the minimum value in the valid range
    
    Specified by:
    
    getValidMin in interface EnhanceScaleMissingUnsigned
  - getValidMax
```
@Deprecated
public double getValidMax()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return the maximum value in the valid range
    
    Specified by:
    
    getValidMax in interface EnhanceScaleMissingUnsigned
  - isInvalidData
```
@Deprecated
public boolean isInvalidData(double val)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val is outside the valid range
    
    Specified by:
    
    isInvalidData in interface EnhanceScaleMissingUnsigned
  - hasFillValue
```
@Deprecated
public boolean hasFillValue()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has _FillValue attribute
    
    Specified by:
    
    hasFillValue in interface EnhanceScaleMissingUnsigned
  - getFillValue
```
@Deprecated
public double getFillValue()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return value of _FillValue attribute
    
    Specified by:
    
    getFillValue in interface EnhanceScaleMissingUnsigned
  - isFillValue
```
@Deprecated
public boolean isFillValue(double val)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val equals the _FillValue
    
    Specified by:
    
    isFillValue in interface EnhanceScaleMissingUnsigned
  - hasMissingValue
```
@Deprecated
public boolean hasMissingValue()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    true if Variable has missing_value attribute
    
    Specified by:
    
    hasMissingValue in interface EnhanceScaleMissingUnsigned
  - getMissingValues
```
@Deprecated
public double[] getMissingValues()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return values of missing_value attributes
    
    Specified by:
    
    getMissingValues in interface EnhanceScaleMissingUnsigned
  - isMissingValue
```
@Deprecated
public boolean isMissingValue(double val)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    return true if val equals a missing_value (low-level)
    
    Specified by:
    
    isMissingValue in interface EnhanceScaleMissingUnsigned
  - getScaledOffsetType
```
@Deprecated
 @Nullable
public DataType getScaledOffsetType()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Return the data type for values that have undergone scale/offset conversion. This will be null if the decorated variable lacks scale_factor or add_offset attributes. You can check with EnhanceScaleMissingUnsigned.hasScaleOffset().
    
    Specified by:
    
    getScaledOffsetType in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the data type for values that have undergone scale/offset conversion.
  - getUnsignedConversionType
```
@Deprecated
public DataType getUnsignedConversionType()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Return the data type for values that have undergone unsigned conversion. This will never be null, even when no unsigned conversion is necessary (because the underlying variable isn't unsigned). In such cases, this data type will be the same as that of the underlying variable.
    
    Specified by:
    
    getUnsignedConversionType in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the data type for values that have undergone unsigned conversion.
  - getSignedness
```
@Deprecated
public DataType.Signedness getSignedness()
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns the signedness of the decorated variable.
    
    Specified by:
    
    getSignedness in interface EnhanceScaleMissingUnsigned
    
    Returns:
    
    the signedness of the decorated variable.
  - applyScaleOffset
```
@Deprecated
public double applyScaleOffset(Number value)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Apply scale and offset to the specified value if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value.
    
    Specified by:
    
    applyScaleOffset in interface EnhanceScaleMissingUnsigned
  - applyScaleOffset
```
@Deprecated
public Array applyScaleOffset(Array data)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Apply scale and offset to each element of in and return the result as a new Array, but only if EnhanceScaleMissingUnsigned.hasScaleOffset(). Otherwise, just return value. Otherwise, just return data.
    
    Specified by:
    
    applyScaleOffset in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    data - convert this
    
    Returns:
    
    converted data.
  - convertUnsigned
```
@Deprecated
public Number convertUnsigned(Number value)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Convert value to the next largest integral data type by an unsigned conversion. The conversion only happens if the decorated variable is unsigned and value is a negative integer. Otherwise, simply return value.
    
    Specified by:
    
    convertUnsigned in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    value - an integral number to convert.
    
    Returns:
    
    the result of an unsigned conversion of value.
  - convertUnsigned
```
@Deprecated
public Array convertUnsigned(Array in)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Performs an unsigned conversion of each element of in and returns the result as a new Array. The data type of the returned array will be EnhanceScaleMissingUnsigned.getUnsignedConversionType().
    
    Specified by:
    
    convertUnsigned in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - an Array containing integral Numbers to convert.
    
    Returns:
    
    the result of an unsigned conversion of each element of in.
  - convertMissing
```
@Deprecated
public Number convertMissing(Number value)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    If value is missing, return Double.NaN. Otherwise, simply return value
    
    Specified by:
    
    convertMissing in interface EnhanceScaleMissingUnsigned
  - convertMissing
```
@Deprecated
public Array convertMissing(Array in)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Returns a copy of in, except that each missing value is replaced by Double.NaN.
    
    Specified by:
    
    convertMissing in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - an array containing floating-point numbers to convert.
    
    Returns:
    
    the result of a missing conversion of each element of in.
  - convert
```
@Deprecated
public Array convert(Array in,
                                  boolean convertUnsigned,
                                  boolean applyScaleOffset,
                                  boolean convertMissing)
```
    Deprecated. do not use
    
    Description copied from interface: EnhanceScaleMissingUnsigned
    
    Perform the specified conversions on each element of in and return the result as a new Array. Note that this method is more efficient than calling EnhanceScaleMissingUnsigned.convertUnsigned(Array), followed by EnhanceScaleMissingUnsigned.applyScaleOffset(Array), followed by EnhanceScaleMissingUnsigned.convertMissing(Array), as only one copy of in is made.
    
    Specified by:
    
    convert in interface EnhanceScaleMissingUnsigned
    
    Parameters:
    
    in - a numeric array.
    
    convertUnsigned - true if we should convert unsigned.
    
    applyScaleOffset - true if we should apply scale/offset.
    
    convertMissing - true if we should convert missing.
    
    Returns:
    
    a new array, with the specified conversions performed.
  - toBuilder
```
public VariableDS.Builder<?> toBuilder()
```
    Description copied from class: Variable
    
    Turn into a mutable Builder. Can use toBuilder().build() to copy.
    
    Overrides:
    
    toBuilder in class Variable
  - addLocalFieldsToBuilder
```
protected VariableDS.Builder<?> addLocalFieldsToBuilder(VariableDS.Builder<? extends VariableDS.Builder<?>> builder)
```
  - builder
```
public static VariableDS.Builder<?> builder()
```
    Get Builder for this class that allows subclassing.

Class VariableDS

Nested Class Summary

Nested classes/interfaces inherited from class ucar.nc2.Variable

Field Summary

Fields inherited from class ucar.nc2.Variable

Constructor Summary

Method Summary

Methods inherited from class ucar.nc2.Variable

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.nc2.dataset.VariableEnhanced

Field Detail

orgVar

orgDataType

orgName

Constructor Detail

VariableDS

Method Detail

fromVar

getNetcdfFile

convertNeeded

convertArray

getEnhanceMode

getOriginalVariable

getOriginalDataType

getOriginalArrayType

getOriginalName

lookupEnumString

toStringDebug

getDatasetLocation

setCaching

toString

_read

readArray

reallyRead

proxyReadArray

_read

reallyRead

readArray

proxyReadArray

readToStream

getMissingDataArray

showScaleMissingProxy

getDescription

getUnitsString

getCoordinateSystems

hasScaleOffset

getScaleFactor

getOffset

hasMissing

isMissing

hasValidData

getValidMin

getValidMax

isInvalidData

hasFillValue

getFillValue

isFillValue

hasMissingValue

getMissingValues

isMissingValue

getScaledOffsetType

getUnsignedConversionType

getSignedness

applyScaleOffset

applyScaleOffset

convertUnsigned

convertUnsigned

convertMissing

convertMissing

convert

toBuilder

addLocalFieldsToBuilder

builder