A DAP Array with file out netcdf information included. More...

#include <FONcArrayStructureField.h>

Inheritance diagram for FONcArrayStructureField:

Collaboration diagram for FONcArrayStructureField:

Public Member Functions
virtual void	clear_embedded ()
	Clears the list of embedded variable names.

void	convert (vector< string > embed, bool _dap4=true, bool is_dap4_group=false) override

void	convert (std::vector< std::string > embed)

void	convert (std::vector< std::string > embed, bool is_dap4)

virtual void	convert (std::vector< std::string > embed, bool is_dap4, bool is_dap4_group)

void	define (int ncid) override
	define the DAP array of structure field in the netcdf file

void	dump (std::ostream &strm) const override
	dumps information about this object for debugging purposes

	FONcArrayStructureField (libdap::BaseType b, libdap::Array a, bool is_netCDF4_enhanced)
	Constructor for FONcArrayStructureField.

libdap::DDS *	get_dds () const

libdap::ConstraintEvaluator *	get_eval () const

bool	get_fdio_flag () const

virtual libdap::AttrType	getAttrType (nc_type t)

virtual D4AttributeType	getD4AttrType (nc_type t)

virtual bool	isNetCDF4 ()
	Returns true if NetCDF4 features will be required.

bool	isNetCDF4_ENHANCED ()

std::string	name () override
	returns the name of the array structure field

void	set_dds (libdap::DDS *dds)

void	set_eval (libdap::ConstraintEvaluator *eval)

void	set_fdio_flag (bool dio_flag_value=true)

virtual void	set_is_dap4 (bool set_dap4)

virtual void	setNC4DataModel (const string &nc4_datamodel)
	Identifies the netCDF4 data model (CLASSIC or ENHANCED)

virtual void	setVersion (const std::string &version)
	Identifies variable with use of NetCDF4 features.

nc_type	type () override
	returns the netcdf type of the DAP object

virtual void	updateAttrType (libdap::AttrTable &attrs, nc_type t)

virtual void	updateD4AttrType (libdap::D4Attributes *d4_attrs, nc_type t)

virtual int	varid () const

void	write (int ncid) override
	Write the netcdf variable data out to the netcdf file.

Static Public Attributes
static std::vector< FONcDim * >	SDimensions

Protected Attributes
libdap::DDS *	d_dds = nullptr

bool	d_defined = false

std::vector< std::string >	d_embed

libdap::ConstraintEvaluator *	d_eval = nullptr

bool	d_is_dap4 = false

bool	d_is_dap4_group = false

std::string	d_nc4_datamodel

std::string	d_ncVersion

std::string	d_orig_varname

int	d_varid = 0

std::string	d_varname

bool	fdio_flag = false

Detailed Description

A DAP Array with file out netcdf information included.

This class represents a DAP Array with additional information needed to write it out to a netcdf file. Includes a reference to the actual DAP Array being converted.

Definition at line 50 of file FONcArrayStructureField.h.

Constructor & Destructor Documentation

◆ FONcArrayStructureField()

FONcArrayStructureField::FONcArrayStructureField	(	libdap::BaseType *	b,
		libdap::Array *	a,
		bool	is_netCDF4_enhanced )

explicit

Constructor for FONcArrayStructureField.

This constructor takes a DAP BaseType and a DAP Array. It makes sure the BaseType is only int/float array or scalar. If not, it throws an exception It will further retrieve the dimension and type information of the base member and the array.

Parameters

b	A DAP BaseType that should be an int/float array or scalar.
a	A DAP Array of structure. It is necessary to retrieve the data and dimension information.

Exceptions

BESInternalError if the BaseType is not an int/float array and the Array is not a DAP array.

Definition at line 62 of file FONcArrayStructureField.cc.

◆ ~FONcArrayStructureField()

FONcArrayStructureField::~FONcArrayStructureField ( )

Definition at line 214 of file FONcArrayStructureField.cc.

Member Function Documentation

◆ clear_embedded()

void FONcBaseType::clear_embedded ( )

virtualinherited

Clears the list of embedded variable names.

Definition at line 93 of file FONcBaseType.cc.

◆ convert() [1/4]

void FONcArrayStructureField::convert	(	vector< string >	embed,
		bool	_dap4 = true,
		bool	is_dap4_group = false )

override

Definition at line 222 of file FONcArrayStructureField.cc.

◆ convert() [2/4]

void FONcBaseType::convert ( std::vector< std::string > embed )

inlineinherited

Definition at line 97 of file FONcBaseType.h.

◆ convert() [3/4]

void FONcBaseType::convert	(	std::vector< std::string >	embed,
		bool	is_dap4 )

inlineinherited

Definition at line 100 of file FONcBaseType.h.

◆ convert() [4/4]

virtual void FONcBaseType::convert	(	std::vector< std::string >	embed,
		bool	is_dap4,
		bool	is_dap4_group )

virtualinherited

Reimplemented in FONcArray.

◆ define()

void FONcArrayStructureField::define ( int ncid )

overridevirtual

define the DAP array of structure field in the netcdf file

Parameters

ncid	The id of the NetCDF file

Exceptions

BESInternalError if there is a problem.

Reimplemented from FONcBaseType.

Definition at line 233 of file FONcArrayStructureField.cc.

◆ dump()

void FONcArrayStructureField::dump ( std::ostream & strm ) const

overridevirtual

dumps information about this object for debugging purposes

Displays the pointer value of this instance plus instance data

Parameters

strm	C++ i/o stream to dump the information to

Implements FONcBaseType.

Definition at line 575 of file FONcArrayStructureField.cc.

◆ get_dds()

libdap::DDS * FONcBaseType::get_dds ( ) const

inlineinherited

Definition at line 89 of file FONcBaseType.h.

◆ get_eval()

libdap::ConstraintEvaluator * FONcBaseType::get_eval ( ) const

inlineinherited

Definition at line 92 of file FONcBaseType.h.

◆ get_fdio_flag()

bool FONcBaseType::get_fdio_flag ( ) const

inlineinherited

Definition at line 129 of file FONcBaseType.h.

◆ getAttrType()

libdap::AttrType FONcBaseType::getAttrType ( nc_type t )

virtualinherited

Definition at line 163 of file FONcBaseType.cc.

◆ getD4AttrType()

D4AttributeType FONcBaseType::getD4AttrType ( nc_type t )

virtualinherited

Definition at line 211 of file FONcBaseType.cc.

◆ isNetCDF4()

bool FONcBaseType::isNetCDF4 ( )

virtualinherited

Returns true if NetCDF4 features will be required.

Definition at line 118 of file FONcBaseType.cc.

◆ isNetCDF4_ENHANCED()

bool FONcBaseType::isNetCDF4_ENHANCED ( )

inherited

Definition at line 123 of file FONcBaseType.cc.

◆ name()

string FONcArrayStructureField::name ( )

overridevirtual

returns the name of the array structure field

Returns: The name of the array structure field

Implements FONcBaseType.

Definition at line 523 of file FONcArrayStructureField.cc.

◆ set_dds()

void FONcBaseType::set_dds ( libdap::DDS * dds )

inlineinherited

Definition at line 90 of file FONcBaseType.h.

◆ set_eval()

void FONcBaseType::set_eval ( libdap::ConstraintEvaluator * eval )

inlineinherited

Definition at line 93 of file FONcBaseType.h.

◆ set_fdio_flag()

void FONcBaseType::set_fdio_flag ( bool dio_flag_value = true )

inlineinherited

Definition at line 130 of file FONcBaseType.h.

◆ set_is_dap4()

virtual void FONcBaseType::set_is_dap4 ( bool set_dap4 )

inlinevirtualinherited

Definition at line 121 of file FONcBaseType.h.

◆ setNC4DataModel()

void FONcBaseType::setNC4DataModel ( const string & nc4_datamodel )

virtualinherited

Identifies the netCDF4 data model (CLASSIC or ENHANCED)

Definition at line 109 of file FONcBaseType.cc.

◆ setVersion()

void FONcBaseType::setVersion ( const std::string & version )

virtualinherited

Identifies variable with use of NetCDF4 features.

Definition at line 100 of file FONcBaseType.cc.

◆ type()

nc_type FONcArrayStructureField::type ( )

overridevirtual

returns the netcdf type of the DAP object

Returns: The nc_type of this field.

Reimplemented from FONcBaseType.

Definition at line 533 of file FONcArrayStructureField.cc.

◆ updateAttrType()

void FONcBaseType::updateAttrType	(	libdap::AttrTable &	attrs,
		nc_type	t )

virtualinherited

Definition at line 144 of file FONcBaseType.cc.

◆ updateD4AttrType()

void FONcBaseType::updateD4AttrType	(	libdap::D4Attributes *	d4_attrs,
		nc_type	t )

virtualinherited

Definition at line 128 of file FONcBaseType.cc.

◆ varid()

virtual int FONcBaseType::varid ( ) const

inlinevirtualinherited

Definition at line 113 of file FONcBaseType.h.

◆ write()

void FONcArrayStructureField::write ( int ncid )

overridevirtual

Write the netcdf variable data out to the netcdf file.

Once the variable is defined, the value of the variable can be written out

Parameters

ncid	The id of the netcdf file

Exceptions

BESInternalError if there is a problem writing the value

Implements FONcBaseType.

Definition at line 271 of file FONcArrayStructureField.cc.

Member Data Documentation

◆ d_dds

libdap::DDS* FONcBaseType::d_dds = nullptr

protectedinherited

Definition at line 76 of file FONcBaseType.h.

◆ d_defined

bool FONcBaseType::d_defined = false

protectedinherited

Definition at line 66 of file FONcBaseType.h.

◆ d_embed

std::vector<std::string> FONcBaseType::d_embed

protectedinherited

Definition at line 65 of file FONcBaseType.h.

◆ d_eval

libdap::ConstraintEvaluator* FONcBaseType::d_eval = nullptr

protectedinherited

Definition at line 77 of file FONcBaseType.h.

◆ d_is_dap4

bool FONcBaseType::d_is_dap4 = false

protectedinherited

Definition at line 71 of file FONcBaseType.h.

◆ d_is_dap4_group

bool FONcBaseType::d_is_dap4_group = false

protectedinherited

Definition at line 74 of file FONcBaseType.h.

◆ d_nc4_datamodel

std::string FONcBaseType::d_nc4_datamodel

protectedinherited

Definition at line 68 of file FONcBaseType.h.

◆ d_ncVersion

std::string FONcBaseType::d_ncVersion

protectedinherited

Definition at line 67 of file FONcBaseType.h.

◆ d_orig_varname

std::string FONcBaseType::d_orig_varname

protectedinherited

Definition at line 64 of file FONcBaseType.h.

◆ d_varid

int FONcBaseType::d_varid = 0

protectedinherited

Definition at line 62 of file FONcBaseType.h.

◆ d_varname

std::string FONcBaseType::d_varname

protectedinherited

Definition at line 63 of file FONcBaseType.h.

◆ fdio_flag

bool FONcBaseType::fdio_flag = false

protectedinherited

Definition at line 82 of file FONcBaseType.h.

◆ SDimensions

vector< FONcDim * > FONcArrayStructureField::SDimensions

static

Definition at line 88 of file FONcArrayStructureField.h.

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

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FONcArrayStructureField()

◆ ~FONcArrayStructureField()

Member Function Documentation

◆ clear_embedded()

◆ convert() [1/4]

◆ convert() [2/4]

◆ convert() [3/4]

◆ convert() [4/4]

◆ define()

◆ dump()

◆ get_dds()

◆ get_eval()

◆ get_fdio_flag()

◆ getAttrType()

◆ getD4AttrType()

◆ isNetCDF4()

◆ isNetCDF4_ENHANCED()

◆ name()

◆ set_dds()

◆ set_eval()

◆ set_fdio_flag()

◆ set_is_dap4()

◆ setNC4DataModel()

◆ setVersion()

◆ type()

◆ updateAttrType()

◆ updateD4AttrType()

◆ varid()

◆ write()

Member Data Documentation

◆ d_dds

◆ d_defined

◆ d_embed

◆ d_eval

◆ d_is_dap4

◆ d_is_dap4_group

◆ d_nc4_datamodel

◆ d_ncVersion

◆ d_orig_varname

◆ d_varid

◆ d_varname

◆ fdio_flag

◆ SDimensions