Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

GRIB_FIELD Class Reference

GRIB Field stored/to be stored im message. More...

#include <GRIB.h>

List of all members.

Public Methods

 GRIB_FIELD ()
 Constructor.

 ~GRIB_FIELD ()
 Destructor.

void Decode (unsigned char *pds, unsigned char *bds, unsigned char *bms, size_t nxny)
 Decode grib parameter stored in message. Do not use.

void set_table (int center, int subcenter, int table, int process)
 Set overall grib identification.

void set_field (int varcode, float *values, size_t size, float undef_high, float undef_low)
 Set field from a float values array.

void set_scale (int scale)
 Set decimal scaling. Stored values will be: sv = val * 10^scale.

std::string VarName ()
 variable name from some hardcoded center/subcenter/process/table

std::string VarUnit ()
 variable units from some hardcoded center/subcenter/process/table

std::string VarDescription ()
 variable description from some hardcoded center/subcenter/process/table


Public Attributes

int center
 Originating center.

int subcenter
 Originating subcenter for center.

int table
 center/subcenter grib table used

int process
 process originating data stored in GRIB (model, satellite, etc.)

int varcode
 variable code

size_t size
 parameter storage size

float * vals
 parameter values

float undef_high
 undefined value used in defining bitmap for stored parameter. HI mark

float undef_low
 undefined value used in defining bitmap for stored parameter. LOW mark

std::string varname
 parameter name

std::string varunit
 parameter unit

std::string vardesc
 parameter description

int numbits
 used in decoding for soring packing info

float refvalue
 used in decoding for soring packing info

int decimalscale
 used in decoding/encoding for soring packing info

int binscale
 used in decoding for soring packing info


Detailed Description

GRIB Field stored/to be stored im message.

Definition at line 938 of file GRIB.h.


Constructor & Destructor Documentation

GRIB_FIELD::GRIB_FIELD  
 

Constructor.

Definition at line 1543 of file GRIB.cpp.

References binscale, center, decimalscale, GRIB_CENTER_LOCAL, GRIB_PARAMETER_UNKNOWN, GRIB_PROCESS_LOCAL, GRIB_SUBCENTER_LOCAL, GRIB_TABLE_INTERNATIONAL, numbits, process, refvalue, size, subcenter, table, undef_high, undef_low, vals, varcode, vardesc, varname, and varunit.

GRIB_FIELD::~GRIB_FIELD  
 

Destructor.

Definition at line 1563 of file GRIB.cpp.

References vals.


Member Function Documentation

void GRIB_FIELD::Decode unsigned char *    pds,
unsigned char *    bds,
unsigned char *    bms,
size_t    nxny
 

Decode grib parameter stored in message. Do not use.

Parameters:
pds:  Encoded pds section of GRIB
bds:  Encoded bds section of GRIB
bms:  Encoded bms section of GRIB
nxny:  expexcted field size from grid definition

Definition at line 1568 of file GRIB.cpp.

References BDS_BinScale, BDS_NumBits, BDS_RefValue, BDS_unpack(), binscale, BMS_bitmap, center, decimalscale, int_power(), numbits, Parm_Table(), PDS_Center, PDS_DecimalScale, PDS_Model, PDS_PARAM, PDS_Subcenter, PDS_Vsn, process, refvalue, size, subcenter, table, vals, varcode, vardesc, varname, and varunit.

Referenced by GRIB_MESSAGE::Decode().

void GRIB_FIELD::set_field int    varcode,
float *    values,
size_t    size,
float    undef_high,
float    undef_low
 

Set field from a float values array.

Parameters:
varcode:  Parameter code
values:  Allocated array filled with parameter values
size:  Size of the previous array
undef_high:  High mark for undefined value in encoding
undef_low:  Low mark for undefined value in encoding

Definition at line 1627 of file GRIB.cpp.

References center, Parm_Table(), process, size, subcenter, table, undef_high, undef_low, vals, varcode, vardesc, varname, and varunit.

void GRIB_FIELD::set_scale int    scale
 

Set decimal scaling. Stored values will be: sv = val * 10^scale.

Parameters:
scale:  decimal scaling in encode

Definition at line 1621 of file GRIB.cpp.

References decimalscale.

void GRIB_FIELD::set_table int    center,
int    subcenter,
int    table,
int    process
 

Set overall grib identification.

Parameters:
center:  Originating center code
subcenter:  Originating subcenter code
table:  Parameter table used in codification
process:  Process generating parameter (model, satellite, etc)

Definition at line 1612 of file GRIB.cpp.

References center, process, subcenter, and table.

std::string GRIB_FIELD::VarDescription  
 

variable description from some hardcoded center/subcenter/process/table

Definition at line 1610 of file GRIB.cpp.

References vardesc.

std::string GRIB_FIELD::VarName  
 

variable name from some hardcoded center/subcenter/process/table

Definition at line 1608 of file GRIB.cpp.

References varname.

std::string GRIB_FIELD::VarUnit  
 

variable units from some hardcoded center/subcenter/process/table

Definition at line 1609 of file GRIB.cpp.

References varunit.


Member Data Documentation

int GRIB_FIELD::binscale
 

used in decoding for soring packing info

Definition at line 1017 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), and GRIB_MESSAGE::set_field().

int GRIB_FIELD::center
 

Originating center.

Definition at line 975 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), set_field(), and set_table().

int GRIB_FIELD::decimalscale
 

used in decoding/encoding for soring packing info

Definition at line 1015 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), and set_scale().

int GRIB_FIELD::numbits
 

used in decoding for soring packing info

Definition at line 1011 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), and GRIB_MESSAGE::set_field().

int GRIB_FIELD::process
 

process originating data stored in GRIB (model, satellite, etc.)

Definition at line 981 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), set_field(), and set_table().

float GRIB_FIELD::refvalue
 

used in decoding for soring packing info

Definition at line 1013 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), and GRIB_MESSAGE::set_field().

size_t GRIB_FIELD::size
 

parameter storage size

Definition at line 987 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), and set_field().

int GRIB_FIELD::subcenter
 

Originating subcenter for center.

Definition at line 977 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), set_field(), and set_table().

int GRIB_FIELD::table
 

center/subcenter grib table used

Definition at line 979 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), set_field(), and set_table().

float GRIB_FIELD::undef_high
 

undefined value used in defining bitmap for stored parameter. HI mark

Definition at line 999 of file GRIB.h.

Referenced by GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), and set_field().

float GRIB_FIELD::undef_low
 

undefined value used in defining bitmap for stored parameter. LOW mark

Definition at line 1001 of file GRIB.h.

Referenced by GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), and set_field().

float* GRIB_FIELD::vals
 

parameter values

Definition at line 989 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), set_field(), and ~GRIB_FIELD().

int GRIB_FIELD::varcode
 

variable code

Definition at line 984 of file GRIB.h.

Referenced by Decode(), GRIB_MESSAGE::Encode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), and set_field().

std::string GRIB_FIELD::vardesc
 

parameter description

Definition at line 1008 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), set_field(), and VarDescription().

std::string GRIB_FIELD::varname
 

parameter name

Definition at line 1004 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), set_field(), and VarName().

std::string GRIB_FIELD::varunit
 

parameter unit

Definition at line 1006 of file GRIB.h.

Referenced by Decode(), GRIB_FIELD(), GRIB_MESSAGE::set_field(), set_field(), and VarUnit().


The documentation for this class was generated from the following files:
Generated on Fri Sep 10 09:52:08 2004 for GRIBLIB by doxygen1.2.18