ARTS  2.2.66
GriddedField Class Referenceabstract

#include <gridded_fields.h>

Inheritance diagram for GriddedField:
Collaboration diagram for GriddedField:

Public Member Functions

Index get_dim () const
 Get the dimension of this gridded field. More...
 
void copy_grids (const GriddedField &gf)
 Copy grids. More...
 
const Stringget_grid_name (Index i) const
 Get grid name. More...
 
Index get_grid_size (Index i) const
 Get the size of a grid. More...
 
GridType get_grid_type (Index i) const
 Get grid type. More...
 
ConstVectorView get_numeric_grid (Index i) const
 Get a numeric grid. More...
 
VectorView get_numeric_grid (Index i)
 Get a numeric grid. More...
 
const ArrayOfStringget_string_grid (Index i) const
 Get a string grid. More...
 
ArrayOfStringget_string_grid (Index i)
 Get a string grid. More...
 
const Stringget_name () const
 Get the name of this gridded field. More...
 
void set_grid (Index i, const Vector &g)
 Set a numeric grid. More...
 
void set_grid (Index i, const ArrayOfString &g)
 Set a string grid. More...
 
void set_grid_name (Index i, const String &s)
 Set grid name. More...
 
void set_name (const String &s)
 Set name of this gridded field. More...
 
virtual bool checksize () const =0
 Consistency check. More...
 
virtual void checksize_strict () const =0
 Strict consistency check. More...
 
virtual ~GriddedField ()
 GriddedField virtual destructor. More...
 

Protected Member Functions

 GriddedField ()
 Construct an empty GriddedField. More...
 
 GriddedField (const Index d, const String &s)
 Construct a GriddedField. More...
 

Private Attributes

Index dim
 
String mname
 
Array< GridTypemgridtypes
 
ArrayOfString mgridnames
 
Array< ArrayOfStringmstringgrids
 
ArrayOfVector mnumericgrids
 

Friends

std::ostream & operator<< (std::ostream &os, const GriddedField &gf)
 

Detailed Description

Abstract base class for gridded fields.

Definition at line 55 of file gridded_fields.h.

Constructor & Destructor Documentation

◆ GriddedField() [1/2]

GriddedField::GriddedField ( )
inlineprotected

Construct an empty GriddedField.

The constructor for GriddedField is protected because it is only used internally by the derived classed.

Definition at line 70 of file gridded_fields.h.

◆ GriddedField() [2/2]

GriddedField::GriddedField ( const Index  d,
const String s 
)
inlineprotected

Construct a GriddedField.

Constructs a GriddedField with the given dimension and name.

The constructor for GriddedField is protected because it is only used internally by the derived classes.

Parameters
[in]dDimension.
[in]sName.

Definition at line 88 of file gridded_fields.h.

◆ ~GriddedField()

virtual GriddedField::~GriddedField ( )
inlinevirtual

GriddedField virtual destructor.

Definition at line 193 of file gridded_fields.h.

References operator<<.

Member Function Documentation

◆ checksize()

virtual bool GriddedField::checksize ( ) const
pure virtual

Consistency check.

Check if the sizes of the grids match the data dimension.

This function must be overwritten by the derived classes.

Returns
True if sizes match.

Implemented in GriddedField6, GriddedField5, GriddedField4, GriddedField3, GriddedField2, and GriddedField1.

Referenced by GriddedField1::checksize_strict(), GriddedField2::checksize_strict(), GriddedField3::checksize_strict(), GriddedField4::checksize_strict(), GriddedField5::checksize_strict(), GriddedField6::checksize_strict(), and set_name().

◆ checksize_strict()

virtual void GriddedField::checksize_strict ( ) const
pure virtual

Strict consistency check.

Same as GriddedField::checksize but throws runtime_error in case of error.

Implemented in GriddedField6, GriddedField5, GriddedField4, GriddedField3, GriddedField2, and GriddedField1.

Referenced by set_name(), and xml_read_from_stream().

◆ copy_grids()

void GriddedField::copy_grids ( const GriddedField gf)

Copy grids.

Copies the grids from the given GriddedField to the current one.

Parameters
[in]gfSource gridded field

Definition at line 61 of file gridded_fields.cc.

References dim, get_dim(), get_grid_type(), get_numeric_grid(), get_string_grid(), GRID_TYPE_NUMERIC, GRID_TYPE_STRING, mgridtypes, mnumericgrids, and mstringgrids.

Referenced by get_dim().

◆ get_dim()

Index GriddedField::get_dim ( ) const
inline

Get the dimension of this gridded field.

Returns
Dimension.

Definition at line 100 of file gridded_fields.h.

References copy_grids(), and dim.

Referenced by chk_griddedfield_gridname(), Compare(), copy_grids(), xml_read_from_stream(), and xml_write_to_stream().

◆ get_grid_name()

◆ get_grid_size()

◆ get_grid_type()

GridType GriddedField::get_grid_type ( Index  i) const
inline

Get grid type.

Returns the type of the grid with index i.

Parameters
[in]iGrid index.
Returns
Grid type.

Definition at line 141 of file gridded_fields.h.

References get_numeric_grid(), and get_string_grid().

Referenced by copy_grids(), and xml_write_to_stream().

◆ get_name()

const String& GriddedField::get_name ( ) const
inline

◆ get_numeric_grid() [1/2]

◆ get_numeric_grid() [2/2]

VectorView GriddedField::get_numeric_grid ( Index  i)

Get a numeric grid.

Returns the numeric grid with index i.

Throws a runtime error if grid i is not of type Numeric.

Parameters
[in]iGrid index.
Returns
Numeric grid.

Definition at line 126 of file gridded_fields.cc.

References dim, GRID_TYPE_NUMERIC, mgridnames, mgridtypes, mname, and mnumericgrids.

◆ get_string_grid() [1/2]

const ArrayOfString & GriddedField::get_string_grid ( Index  i) const

Get a string grid.

Returns the string grid with index i.

Throws a runtime error if grid i is not of type String.

Parameters
[in]iGrid index.
Returns
String grid.

Definition at line 159 of file gridded_fields.cc.

References dim, GRID_TYPE_STRING, mgridnames, mgridtypes, mname, and mstringgrids.

Referenced by antenna1d_matrix(), atm_fields_compactExpand(), AtmFieldsFromCompact(), copy_grids(), get_grid_type(), sensor_responseAntenna(), and xml_write_to_stream().

◆ get_string_grid() [2/2]

ArrayOfString & GriddedField::get_string_grid ( Index  i)

Get a string grid.

Returns the string grid with index i.

Throws a runtime error if grid i is not of type String.

Parameters
[in]iGrid index.
Returns
String grid.

Definition at line 193 of file gridded_fields.cc.

References dim, GRID_TYPE_STRING, mgridnames, mgridtypes, mname, and mstringgrids.

◆ set_grid() [1/2]

◆ set_grid() [2/2]

void GriddedField::set_grid ( Index  i,
const ArrayOfString g 
)

Set a string grid.

Sets grid i to the given grid.

Parameters
[in]iGrid index.
[in]gNew grid.

Definition at line 241 of file gridded_fields.cc.

References dim, GRID_TYPE_STRING, mgridtypes, mnumericgrids, and mstringgrids.

◆ set_grid_name()

◆ set_name()

void GriddedField::set_name ( const String s)
inline

Set name of this gridded field.

Parameters
[in]sGridded field name.

Definition at line 174 of file gridded_fields.h.

References checksize(), and checksize_strict().

Referenced by antenna_responseGaussian(), antenna_responseVaryingGaussian(), main(), sensor_responseGenericAMSU(), sensor_responseSimpleAMSU(), and xml_read_from_stream().

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ dim

Index GriddedField::dim
private

◆ mgridnames

ArrayOfString GriddedField::mgridnames
private

Definition at line 60 of file gridded_fields.h.

Referenced by get_numeric_grid(), get_string_grid(), and operator<<().

◆ mgridtypes

Array<GridType> GriddedField::mgridtypes
private

Definition at line 59 of file gridded_fields.h.

Referenced by copy_grids(), get_numeric_grid(), get_string_grid(), operator<<(), and set_grid().

◆ mname

String GriddedField::mname
private

Definition at line 58 of file gridded_fields.h.

Referenced by get_name(), get_numeric_grid(), get_string_grid(), and operator<<().

◆ mnumericgrids

ArrayOfVector GriddedField::mnumericgrids
private

Definition at line 62 of file gridded_fields.h.

Referenced by copy_grids(), get_numeric_grid(), operator<<(), and set_grid().

◆ mstringgrids

Array<ArrayOfString> GriddedField::mstringgrids
private

Definition at line 61 of file gridded_fields.h.

Referenced by copy_grids(), get_string_grid(), operator<<(), and set_grid().


The documentation for this class was generated from the following files: