Package com.luciad.format.grib

Class TLcdGRIBModelDescriptor

java.lang.Object
com.luciad.model.TLcdModelDescriptor
com.luciad.format.raster.TLcdRasterModelDescriptor
com.luciad.format.grib.TLcdGRIBModelDescriptor
All Implemented Interfaces:
ILcdGRIBConstants, ILcdModelDescriptor, Serializable
Direct Known Subclasses:
TLcdGRIB2ModelDescriptor
@Deprecated public class TLcdGRIBModelDescriptor extends TLcdRasterModelDescriptor implements ILcdModelDescriptor, ILcdGRIBConstants
Deprecated.
The NetCDF decoder should be used to decode GRIB data.
Model descriptor for GRIB models.

TLcdGRIBModelDescriptor contains the values of D, R, E to calculate the original value of a parameter with the formula:

Y * 10D = R + (X*2E)

where

  • Y = original or unpacked value;
  • D = decimal scale factor;
  • R = reference value;
  • X = internal value;
  • E = binary scalefactor;
It also contains methods to calculate original values out of internal values, and vice versa (getActualValue, getInternalValue).

It also contains methods to get the IDs of many features of the GRIB file (e.g. the parameter, the unit of the parameter, the level, originating center, date, grid...). There are some methods that return the meaning of those IDs in a String (getLevel, getGeneratingProcessOrModel, getParameter). For others IDs, the meaning can be found in the tables of the GRIB specification.

There are methods that return the value of the level or layer (getLevelValue, getLayerBottomValue, getLayerTopValue) and the unit for that value (getLevelValueUnit).

Since:
6.5
See Also:

  • Field Details

  • Constructor Details

    • TLcdGRIBModelDescriptor

      public TLcdGRIBModelDescriptor(String aSourceName, String aDisplayName, String aTypeName)
      Deprecated.
      Creates a new TLcdGRIBModelDescriptor with the given names.
      Parameters:
      aSourceName - the name of the data source.
      aDisplayName - the display name of the data source.
      aTypeName - the type name of the data source.

  • Method Details

    • getGRIBEdition

      public int getGRIBEdition()
      Deprecated.
      Returns the edition number of the GRIB format. The only values that are currently supported are 1 and 2.
      Returns:
      1 or 2.
      See Also:

    • setGRIBEdition

      public void setGRIBEdition(int aGRIBEdition)
      Deprecated.
      Sets the edition number of the GRIB format.
      Parameters:
      aGRIBEdition - The edition number of the GRIB format. Should be 1 or 2.
      See Also:

    • getParameterTableVersion

      public int getParameterTableVersion()
      Deprecated.
      Returns the Parameter Table Version number. (Parameter table version numbers 128-254 are reserved for local use.)
      Returns:
      The parameter table version number.
      See Also:

    • setParameterTableVersion

      public void setParameterTableVersion(int aParameterTableVersion)
      Deprecated.
      Sets the Parameter Table Version number.
      Parameters:
      aParameterTableVersion - The parameter table version number.
      See Also:

    • getOriginatingCenterID

      public int getOriginatingCenterID()
      Deprecated.
      Returns the identification number of the originating center. Table 0 of the GRIB specification defines the centers corresponding to the originating center IDs.
      Returns:
      The identification number of the originating center.
      See Also:

    • setOriginatingCenterID

      public void setOriginatingCenterID(int aOriginatingCenterID)
      Deprecated.
      Sets the identification number of the originating center.
      Parameters:
      aOriginatingCenterID - The identification number of the originating center.
      See Also:

    • getGeneratingProcessOrModelID

      public int getGeneratingProcessOrModelID()
      Deprecated.
      Returns the identification number of the process or model generating the GRIB data. Table A of the GRIB specification defines the processes and models corresponding to the IDs.
      Returns:
      The identification number of the process or model generating the data.
      See Also:

    • setGeneratingProcessOrModelID

      public void setGeneratingProcessOrModelID(int aGeneratingProcessOrModelID)
      Deprecated.
      Sets the identification number of the process or model generating the GRIB data.
      Parameters:
      aGeneratingProcessOrModelID - The identification number of the process or model generating the data.
      See Also:

    • getGridID

      public int getGridID()
      Deprecated.
      Returns the identification number of the grid. Table B of the GRIB specification defines the grids corresponding to the grid IDs.
      Returns:
      The identification number of the grid.
      See Also:

    • setGridID

      public void setGridID(int aGridID)
      Deprecated.
      Sets the identification number of the grid.
      Parameters:
      aGridID - The identification number of the grid.
      See Also:

    • getParameterIndicator

      public int getParameterIndicator()
      Deprecated.
      Returns the number of the parameter. Table B of the GRIB specification defines the parameters corresponding to the parameter indicators.
      Returns:
      The number of the parameter.
      See Also:

    • setParameterIndicator

      public void setParameterIndicator(int aParameterIndicator)
      Deprecated.
      Sets the number of the parameter.
      Parameters:
      aParameterIndicator - The number of the parameter.
      See Also:

    • getYear

      public int getYear()
      Deprecated.
      Returns the year of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Returns:
      The year of the time of forecast.
      See Also:

    • setYear

      public void setYear(int aYear)
      Deprecated.
      Sets the year of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Parameters:
      aYear - The year of the time of forecast.
      See Also:

    • getMonth

      public int getMonth()
      Deprecated.
      Returns the month of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Returns:
      The month of the time of forecast,
      See Also:

    • setMonth

      public void setMonth(int aMonth)
      Deprecated.
      Sets the month of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Parameters:
      aMonth - The month of the time of forecast.
      See Also:

    • getDay

      public int getDay()
      Deprecated.
      Returns the day of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Returns:
      The day of the time of forecast.
      See Also:

    • setDay

      public void setDay(int aDay)
      Deprecated.
      Sets the day of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Parameters:
      aDay - The day of the time of forecast.
      See Also:

    • getHour

      public int getHour()
      Deprecated.
      Returns the hour of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Returns:
      The hour of the time of forecast.
      See Also:

    • setHour

      public void setHour(int aHour)
      Deprecated.
      Sets the hour of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Parameters:
      aHour - The hour of the time of forecast.
      See Also:

    • getMinute

      public int getMinute()
      Deprecated.
      Returns the minute of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Returns:
      The minute of the time of forecast.
      See Also:

    • setMinute

      public void setMinute(int aMinute)
      Deprecated.
      Sets the minute of the time of forecast or start of time period (for averaging or accumulation of analysis).
      Parameters:
      aMinute - The minute of the time of forecast.
      See Also:

    • getForecastTimeUnit

      public int getForecastTimeUnit()
      Deprecated.
      Returns the number of the forecast time unit. Table 4 of the GRIB specification defines the forecast time units.
      Returns:
      The number of the forecast time unit.
      See Also:

    • setForecastTimeUnit

      public void setForecastTimeUnit(int aForecastTimeUnit)
      Deprecated.
      Sets the number of the forecast time unit.
      Parameters:
      aForecastTimeUnit - The number of the forecast time unit.
      See Also:

    • getPeriodOfTimeP1

      public int getPeriodOfTimeP1()
      Deprecated.
      Returns the period of time P1, expressed as a number of time units. It is 0 for analysis or initialized analysis.
      Returns:
      The period of time P1.
      See Also:

    • setPeriodOfTimeP1

      public void setPeriodOfTimeP1(int aPeriodOfTimeP1)
      Deprecated.
      Sets the period of time P1, expressed as a number of time units.
      Parameters:
      aPeriodOfTimeP1 - The period of time P1.
      See Also:

    • getPeriodOfTimeP2

      public int getPeriodOfTimeP2()
      Deprecated.
      Returns the period of time P2, expressed as a number of time units. It is 0 for analysis or initialized analysis.
      Returns:
      The period of time P2.
      See Also:

    • setPeriodOfTimeP2

      public void setPeriodOfTimeP2(int aPeriodOfTimeP2)
      Deprecated.
      Sets the period of time P2, expressed as a number of time units.
      Parameters:
      aPeriodOfTimeP2 - The period of time P2.
      See Also:

    • getTimeInterval

      public int getTimeInterval()
      Deprecated.
      Returns the time interval between successive analysis, successive initialized analysis, or forecasts, undergoing averaging or accumulation, expressed as a number of time units.
      Returns:
      The time interval between successive forecasts.
      See Also:

    • setTimeInterval

      public void setTimeInterval(int aTimeInterval)
      Deprecated.
      Sets the time interval between successive analysis, successive initialized analysis, or forecasts, undergoing averaging or accumulation, expressed as a number of time units.
      Parameters:
      aTimeInterval - The time interval between successive forecasts.
      See Also:

    • getTimeRangeIndicator

      public int getTimeRangeIndicator()
      Deprecated.
      Returns the time range indicator.
      Returns:
      The time range indicator.
      See Also:

    • setTimeRangeIndicator

      public void setTimeRangeIndicator(int aTimeRangeIndicator)
      Deprecated.
      Sets the time range indicator.
      Parameters:
      aTimeRangeIndicator - the time range indicator.
      See Also:

    • getLevelIndicator

      public int getLevelIndicator()
      Deprecated.
      Returns the identification number of the level or layer. Table 3 of the GRIB specification defines the levels corresponding to the level IDs.
      Returns:
      The identification number of the level or layer.
      See Also:

    • setLevelIndicator

      public void setLevelIndicator(int aLevelIndicator)
      Deprecated.
      Sets the identification number of the level or layer.
      Parameters:
      aLevelIndicator - The identification number of the level or layer.
      See Also:

    • getLayerTopValue

      public int getLayerTopValue()
      Deprecated.
      Returns the top value of the layer, if specified. Otherwise, it is 0.
      Returns:
      The top value of the layer.
      See Also:

    • setLayerTopValue

      public void setLayerTopValue(int aLayerTopValue)
      Deprecated.
      Sets the top value of the layer.
      Parameters:
      aLayerTopValue - The top value of the layer.
      See Also:

    • getLayerBottomValue

      public int getLayerBottomValue()
      Deprecated.
      Returns the bottom value of the layer, if specified. Otherwise, it is 0.
      Returns:
      The bottom value of the layer.
      See Also:

    • setLayerBottomValue

      public void setLayerBottomValue(int aLayerBottomValue)
      Deprecated.
      Sets the bottom value of the layer.
      Parameters:
      aLayerBottomValue - The bottom value of the layer.
      See Also:

    • getLevelValue

      public int getLevelValue()
      Deprecated.
      Returns the value of the level, if specified. Otherwise, it is 0.
      Returns:
      The value of the level.
      See Also:

    • setLevelValue

      public void setLevelValue(int aLevelValue)
      Deprecated.
      Sets the value of the level.
      Parameters:
      aLevelValue - The value of the level.
      See Also:

    • getNumberIncludedInAverage

      public int getNumberIncludedInAverage()
      Deprecated.
      Sets the number included in the average, when the time range indicator indicates an average or accumulation. Otherwise, it is zero.
      Returns:
      The number included in the average.
      See Also:

    • setNumberIncludedInAverage

      public void setNumberIncludedInAverage(int aNumberIncludedInAverage)
      Deprecated.
      Sets the number included in the average.
      Parameters:
      aNumberIncludedInAverage - The number included in the average.
      See Also:

    • getNumberMissingFromAveragesOrAccumulations

      public int getNumberMissingFromAveragesOrAccumulations()
      Deprecated.
      Returns the number missing from averages or accumulations.
      Returns:
      The number missing from averages.
      See Also:

    • setNumberMissingFromAveragesOrAccumulations

      public void setNumberMissingFromAveragesOrAccumulations(int aNumberMissingFromAveragesOrAccumulations)
      Deprecated.
      Sets the number missing from averages or accumulations.
      Parameters:
      aNumberMissingFromAveragesOrAccumulations - The number missing from averages.
      See Also:

    • getCenturyOfInitialReferenceTime

      public int getCenturyOfInitialReferenceTime()
      Deprecated.
      Returns the century of the initial reference time. Note that it is 20 until Jan. 1, 2001.
      Returns:
      The century of the initial reference time.
      See Also:

    • setCenturyOfInitialReferenceTime

      public void setCenturyOfInitialReferenceTime(int aCenturyOfInitialReferenceTime)
      Deprecated.
      Sets the century of the initial reference time.
      Parameters:
      aCenturyOfInitialReferenceTime - The century of initial reference time.
      See Also:

    • getSubCenterID

      public int getSubCenterID()
      Deprecated.
      Returns the identification number of the subcenter. Table C of the GRIB specification defines the subcenters corresponding to the subcenter IDs.
      Returns:
      The identification number of the subcenter.
      See Also:

    • setSubCenterID

      public void setSubCenterID(int aSubCenterID)
      Deprecated.
      Sets the identification number of the subcenter.
      Parameters:
      aSubCenterID - The identification number of the subcenter.
      See Also:

    • getDataRepresentationType

      public int getDataRepresentationType()
      Deprecated.
      Returns the identification number of the data representation type. Table 6 of the GRIB specification defines the data presentation type.
      Returns:
      The identification number of the data representation type.
      See Also:

    • setDataRepresentationType

      public void setDataRepresentationType(int aDataRepresentationType)
      Deprecated.
      Sets the identification number of the data representation type.
      Parameters:
      aDataRepresentationType - The identification number of the data representation type.
      See Also:

    • getDecimalScaleFactor

      public int getDecimalScaleFactor()
      Deprecated.
      Returns the decimal scale factor D of the data in the GRIB file.
      Returns:
      The decimal scale factor D of the data.
      See Also:

    • setDecimalScaleFactor

      public void setDecimalScaleFactor(int aDecimalScaleFactor)
      Deprecated.
      Sets the decimal scale factor D of the data in the GRIB file.
      Parameters:
      aDecimalScaleFactor - the decimal scale factor D of the data.
      See Also:

    • getBinaryScaleFactor

      public int getBinaryScaleFactor()
      Deprecated.
      Returns the binary scale factor E of the data in the GRIB file.
      Returns:
      The binary scale factor E of the data.
      See Also:

    • setBinaryScaleFactor

      public void setBinaryScaleFactor(int aBinaryScaleFactor)
      Deprecated.
      Sets the binary scale factor E of the data in the GRIB file.
      Parameters:
      aBinaryScaleFactor - The binary scale factor E of the data.
      See Also:

    • getReferenceValue

      public double getReferenceValue()
      Deprecated.
      Returns the reference value R of the data in the GRIB file.
      Returns:
      The reference value R of the data.
      See Also:

    • setReferenceValue

      public void setReferenceValue(double aReferenceValue)
      Deprecated.
      Sets the reference value R of the data in the GRIB file.
      Parameters:
      aReferenceValue - The reference value R of the data.
      See Also:

    • getBitCount

      public int getBitCount()
      Deprecated.
      Returns the number of bits into which a value is packed.
      Returns:
      The number of bits into which a value is packed.
      See Also:

    • setBitCount

      public void setBitCount(int aBitCount)
      Deprecated.
      Sets the number of bits into which a value is packed.
      Parameters:
      aBitCount - The number of bits into which a value is packed.
      See Also:

    • getVerticalCoordinateParameters

      public double[] getVerticalCoordinateParameters()
      Deprecated.
      Returns the vertical coordinate parameters associated with hybrid vertical coordinate systems
      Returns:
      The vertical coordinate parameters associated with hybrid vertical coordinate systems.
      See Also:

    • setVerticalCoordinateParameters

      public void setVerticalCoordinateParameters(double[] aVerticalCoordinateParameters)
      Deprecated.
      Sets the vertical coordinate parameters associated with hybrid vertical coordinate systems.
      Parameters:
      aVerticalCoordinateParameters - The vertical coordinate parameters associated with hybrid vertical coordinate systems.
      See Also:

    • getParameter

      public String getParameter()
      Deprecated.
      Returns the description (name) of the parameter of the model.
      Returns:
      The description of the parameter of the model.
      See Also:

    • setParameter

      public void setParameter(String aParameter)
      Deprecated.
      Sets the description (name) of the parameter of the model.
      Parameters:
      aParameter - The description of the parameter of the model.
      See Also:

    • getParameterUnit

      public String getParameterUnit()
      Deprecated.
      Returns the measurement unit of the parameter of the model.
      Returns:
      The measurement unit of the parameter of the model.
      See Also:

    • setParameterUnit

      public void setParameterUnit(String aParameterUnit)
      Deprecated.
      Sets the measurement unit of the parameter of the model.
      Parameters:
      aParameterUnit - The measurement unit of the parameter of the model.
      See Also:

    • getParameterAbbreviation

      public String getParameterAbbreviation()
      Deprecated.
      Returns the abbreviation of the parameter of the model.
      Returns:
      The abbreviation of the parameter of the model.
      See Also:

    • setParameterAbbreviation

      public void setParameterAbbreviation(String aParameterAbbreviation)
      Deprecated.
      Sets the abbreviation of the parameter of the model.
      Parameters:
      aParameterAbbreviation - The abbreviation of the parameter of the model.
      See Also:

    • getOrganization

      public String getOrganization()
      Deprecated.
      Returns the name of the organization.
      Returns:
      The name of the organization.
      See Also:

    • setOrganization

      public void setOrganization(String aOrganization)
      Deprecated.
      Sets the name of the organization.
      Parameters:
      aOrganization - The name of the organization.
      See Also:

    • getUsage

      public String getUsage()
      Deprecated.
      Returns the text describing the usage of the parameter table.
      Returns:
      The text describing the usage of the parameter table.
      See Also:

    • setUsage

      public void setUsage(String aUsage)
      Deprecated.
      Sets the text describing the usage of the parameter table.
      Parameters:
      aUsage - The text describing the usage of the parameter table.
      See Also:

    • getGeneratingProcessOrModel

      public String getGeneratingProcessOrModel()
      Deprecated.
      Returns the name of the generating process or model, or the constant UNKNOWN if they are not known.
      Returns:
      The name of the generating process or model.
      See Also:

    • setLevelValues

      public void setLevelValues(int aLayerBottomValue, int aLayerTopValue)
      Deprecated.
      Sets the bottom and top values of a layer, if they are specified. Sets the value of a level, if it is specified. The values that are not specified are set to 0.
      Parameters:
      aLayerBottomValue - The bottom value of the layer.
      aLayerTopValue - The top value of the layer.
      See Also:

    • getLevel

      public String getLevel()
      Deprecated.
      Returns the name of the level or layer of the GRIB file, or the constant UNKNOWN if the level is not set.
      Returns:
      The name of the level or layer of the GRIB file.
      See Also:

    • getLevelValueUnit

      public String getLevelValueUnit()
      Deprecated.
      Returns the unit in which the value is expressed, or the empty string if the level is not set.
      Returns:
      The unit in which the value is expressed.
      See Also:

    • getInternalValue

      public int getInternalValue(double aOriginalValue)
      Deprecated.
      Converts a given actual parameter value into the value that is stored internally in the GRIB file.
      Parameters:
      aOriginalValue - The value to convert.
      Returns:
      The internal value corresponding with the given parameter value.
      See Also:

    • getActualValue

      public double getActualValue(int aInternalValue)
      Deprecated.
      Converts a given parameter value that is stored internally in the GRIB file into into the actual value.
      Parameters:
      aInternalValue - The value to convert.
      Returns:
      The parameter value corresponding to the given internal value.
      See Also: