ucar.nc2
Class StructurePseudo

java.lang.Object
  ucar.nc2.Variable
      ucar.nc2.Structure
          ucar.nc2.StructurePseudo

All Implemented Interfaces:

java.lang.Comparable<VariableSimpleIF>, ProxyReader, VariableIF, VariableSimpleIF

Deprecated. use ucar.nc2.dataset.StructurePseudoDS

public class StructurePseudo
extends Structure

Make a collection of variables with the same outer dimension into a fake Structure. Its fake because the variables are not stored contiguously.

  so
   var1(dim, other);
   var2(dim, other);
   var3(dim, other);
 becomes
   struct {
     var1(other);
     var2(other);
     var3(other);
   } name(dim);
 

Author:

caron

Field Summary

Fields inherited from class ucar.nc2.Variable

defaultCoordsSizeToCache, defaultSizeToCache

Constructor Summary

StructurePseudo(NetcdfFile ncfile, Group group, java.lang.String shortName, Dimension dim)
Deprecated. Make a Structure out of all Variables with the named dimension as their outermost dimension.

StructurePseudo(NetcdfFile ncfile, Group group, java.lang.String shortName, java.util.List<java.lang.String> varNames, Dimension dim)
Deprecated. Make a Structure out of named Variables, each has the same named outermost dimension.

Method Summary

Array	reallyRead(Variable mainv, CancelTask cancelTask) Deprecated. public by accident, do not call directly.
Array	reallyRead(Variable mainv, Section section, CancelTask cancelTask) Deprecated. public by accident, do not call directly.
boolean	removeMemberVariable(Variable v) Deprecated. Remove a Variable : uses the Variable name to find it.

Methods inherited from class ucar.nc2.Structure

addMemberVariable, calcElementSize, findVariable, getElementSize, getNameAndAttributes, getNumberOfMemberVariables, getStructureIterator, getStructureIterator, getVariableNames, getVariables, isCaching, isSubset, makeStructureMembers, readStructure, readStructure, readStructure, replaceMemberVariable, select, select, setCaching, setImmutable, setMemberVariables, setParentGroup

Methods inherited from class ucar.nc2.Variable

addAttribute, compareTo, createNewCache, equals, findAttribute, findAttributeIgnoreCase, findDimensionIndex, getAttributes, getDataType, getDescription, getDimension, getDimensions, getDimensionsAll, getDimensionsString, getEnumTypedef, getName, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameAndDimensions, getNameEscaped, getParentGroup, getParentStructure, getProxyReader, getRanges, getRank, getShape, getShape, getShapeAll, getShapeAsSection, getShortName, getSize, getSizeToCache, getSPobject, getUnitsString, hasCachedData, hashCode, invalidateCache, isCoordinateVariable, isImmutable, isMemberOfStructure, isMetadata, isScalar, isUnknownLength, isUnlimited, isUnsigned, isVariableLength, lookupEnumString, read, read, read, read, read, readScalarByte, readScalarDouble, readScalarFloat, readScalarInt, readScalarLong, readScalarShort, readScalarString, readToByteChannel, remove, removeAttribute, removeAttributeIgnoreCase, resetDimensions, resetShape, section, section, setCachedData, setCachedData, setDataType, setDimension, setDimensions, setDimensions, setDimensionsAnonymous, setElementSize, setEnumTypedef, setIsScalar, setName, setParentStructure, setProxyReader, setSizeToCache, setSPobject, slice, toString, toStringDebug, writeCDL

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StructurePseudo

public StructurePseudo(NetcdfFile ncfile,
                       Group group,
                       java.lang.String shortName,
                       Dimension dim)

Deprecated.

Make a Structure out of all Variables with the named dimension as their outermost dimension.

Parameters:

ncfile - part of this file

group - part of this group

shortName - short name of this Structure

dim - the existing dimension

StructurePseudo

public StructurePseudo(NetcdfFile ncfile,
                       Group group,
                       java.lang.String shortName,
                       java.util.List<java.lang.String> varNames,
                       Dimension dim)

Deprecated.

Make a Structure out of named Variables, each has the same named outermost dimension.

Parameters:

ncfile - part of this file

group - part of this group

shortName - short name of this Structure

varNames - limited to these variables. all must have dim as outer dimension.

dim - the existing dimension

Method Detail

removeMemberVariable

public boolean removeMemberVariable(Variable v)

Deprecated.

Description copied from class: Structure

Remove a Variable : uses the Variable name to find it.

Overrides:

removeMemberVariable in class Structure

Parameters:

v - remove this variable as a member of this structure

Returns:

true if was found and removed

reallyRead

public Array reallyRead(Variable mainv,
                        CancelTask cancelTask)
                 throws java.io.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:

mainv - the client Variable

cancelTask - user may cancel

Returns:

Array

Throws:

java.io.IOException - on error

reallyRead

public Array reallyRead(Variable mainv,
                        Section section,
                        CancelTask cancelTask)
                 throws java.io.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:

mainv - the client Variable

section - the section of data to read.

cancelTask - user may cancel

Returns:

Array

Throws:

java.io.IOException - on error

InvalidRangeException - if section has incorrect rank or illegal shape.