bes Updated for version 3.21.1
The Backend Server (BES) is the lower two tiers of the Hyrax data server
Public Member Functions | List of all members
FONcTransform Class Referenceabstract

Transformation object that converts an OPeNDAP DataDDS to a netcdf file. More...

#include <FONcTransform.h>

Inheritance diagram for FONcTransform:
Inheritance graph
Collaboration diagram for FONcTransform:
Collaboration graph

Public Member Functions

virtual void dump (std::ostream &strm) const =0
 dump the contents of this object to the specified ostream
 
virtual void dump (ostream &strm) const
 dumps information about this transformation object for debugging purposes
 
 FONcTransform (BESResponseObject *obj, BESDataHandlerInterface *dhi, const std::string &localfile, const std::string &ncVersion="netcdf")
 Constructor that creates transformation object from the specified BESResponseObject object to the specified file.
 
bool get_gdio_flag () const
 
void set_gdio_flag (bool dio_flag_value=true)
 
virtual void transform_dap2 ()
 Transforms each of the variables of the DataDDS to the NetCDF file.
 
virtual void transform_dap4 ()
 Transforms each of the variables of the DMR to the NetCDF file.
 
virtual ~FONcTransform ()
 Destructor.
 

Detailed Description

Transformation object that converts an OPeNDAP DataDDS to a netcdf file.

This class transforms each variable of the DataDDS to a netcdf file. For more information on the transformation please refer to the OpeNDAP documents wiki.

Definition at line 60 of file FONcTransform.h.

Constructor & Destructor Documentation

◆ FONcTransform()

FONcTransform::FONcTransform ( BESResponseObject * obj,
BESDataHandlerInterface * dhi,
const std::string & localfile,
const std::string & ncVersion = "netcdf" )

Constructor that creates transformation object from the specified BESResponseObject object to the specified file.

Parameters
ddsDataDDS object that contains the data structure, attributes and data
dhiThe data interface containing information about the current request
localfilenetcdf to create and write the information to
Exceptions
BESInternalErrorif dds provided is empty or not read, if the file is not specified or failed to create the netcdf file

Definition at line 100 of file FONcTransform.cc.

◆ ~FONcTransform()

FONcTransform::~FONcTransform ( )
virtual

Destructor.

Cleans up any temporary data created during the transformation

Definition at line 129 of file FONcTransform.cc.

Member Function Documentation

◆ dump() [1/2]

virtual void BESObj::dump ( std::ostream & strm) const
pure virtualinherited

dump the contents of this object to the specified ostream

This method is implemented by all derived classes to dump their contents, in other words, any state they might have, private variables, etc...

The inline function below can be used to dump the contents of an OPeNDAPObj object. For example, the object Animal is derived from BESObj. A user could do the following:

Animal *a = new dog( "Sparky" ) ; cout << a << endl ;

And the dump method for dog could display the name passed into the constructor, the (this) pointer of the object, etc...

Parameters
strmC++ i/o stream to dump the object to

Implemented in bes::CatalogItem, bes::CatalogNode, bes::NullResponseHandler, bes::SetContextsResponseHandler, bes::ShowNodeCommand, bes::ShowNodeResponseHandler, bes::XMLSetContextsCommand, BESAbstractModule, BESApp, BESAsciiModule, BESAsciiRequestHandler, BESCatalog, BESCatalogDirectory, BESCatalogEntry, BESCatalogList, BESCatalogResponseHandler, BESCatalogUtils, BESConfigResponseHandler, BESContainer, BESContainerStorage, BESContainerStorageFile, BESContainerStorageList, BESContainerStorageVolatile, BESContextManager, BESDap4ResponseHandler, BESDapModule, BESDapRequestHandler, BESDapResponse, BESDASResponse, BESDASResponseHandler, BESDataDDSResponse, BESDataDDXResponseHandler, BESDataHandlerInterface, BESDataResponseHandler, BESDDSResponse, BESDDSResponseHandler, BESDDXResponseHandler, BESDefine, BESDefineResponseHandler, BESDefinitionStorage, BESDefinitionStorageList, BESDefinitionStorageVolatile, BESDelContainerResponseHandler, BESDelContainersResponseHandler, BESDelDefResponseHandler, BESDelDefsResponseHandler, BESDMRResponse, BESDMRResponseHandler, BESError, BESFileContainer, BESFileContainerStorage, BESFileLockingCache, BESForbiddenError, BESHelpResponseHandler, BESHTMLInfo, BESInfo, BESInfoList, BESInterface, BESInternalError, BESInternalFatalError, BESLog, BESModuleApp, BESNotFoundError, BESPlugin< M >, BESPlugin< BESAbstractModule >, BESPlugin< C >, BESPluginFactory< C >, BESPluginFactory< BESAbstractModule >, BESProcIdResponseHandler, BESReporter, BESReporterList, BESRequestHandler, BESRequestHandlerList, BESResponseHandler, BESResponseHandlerList, BESResponseObject, BESReturnManager, BESServerHandler, BESServiceRegistry, BESServicesResponseHandler, BESSetContainerResponseHandler, BESSetContextResponseHandler, BESShowContainersResponseHandler, BESShowContextResponseHandler, BESShowDefsResponseHandler, BESShowErrorResponseHandler, BESStatusResponseHandler, BESStopWatch, BESStreamResponseHandler, BESSyntaxUserError, BESTextInfo, BESTimeoutError, BESTokenizer, BESTransmitter, BESUncompressManager3, BESUsage, BESUsageModule, BESUsageRequestHandler, BESVersionInfo, BESVersionResponseHandler, BESWWW, BESWWWModule, BESWWWRequestHandler, BESXDModule, BESXDRequestHandler, BESXMLCatalogCommand, BESXMLCommand, BESXMLDapCommandModule, BESXMLDefineCommand, BESXMLDeleteContainerCommand, BESXMLDeleteContainersCommand, BESXMLDeleteDefinitionCommand, BESXMLDeleteDefinitionsCommand, BESXMLGetCommand, BESXMLInfo, BESXMLInterface, BESXMLSetContainerCommand, BESXMLSetContextCommand, BESXMLShowCommand, BESXMLShowErrorCommand, BESXMLWWWGetCommand, builddmrpp::BuildDmrppModule, builddmrpp::BuildDmrppRequestHandler, builddmrpp::NgapBuildDmrppContainer, builddmrpp::NgapBuildDmrppContainerStorage, CatalogItem, CmdApp, CmdClient, cmr::CmrCatalog, cmr::CmrContainer, cmr::CmrContainerStorage, cmr::CmrInternalError, cmr::CmrNotFoundError, CmrModule, Connection, CSV_Field, CSV_Header, CSV_Obj, CSV_Reader, CSVModule, CSVRequestHandler, DaemonCommandHandler, DapFunctionsRequestHandler, DapModule, DapRequestHandler, dmrpp::DmrppModule, dmrpp::DmrppRequestHandler, EffectiveUrlCache, FFModule, FitsModule, FitsRequestHandler, FoCovJsonModule, FoCovJsonRequestHandler, FoDapCovJsonTransform, FoDapJsonTransform, FoInstanceJsonTransform, FoJsonModule, FoJsonRequestHandler, FONcArray, FONcArrayStructureField, FONcBaseType, FONcDim, FONcMap, FONcModule, FONcRequestHandler, FONgType, functions::DapFunctions, gateway::GatewayContainer, gateway::GatewayContainerStorage, gateway::GatewayModule, gateway::GatewayRequestHandler, GatewayPathInfoCommand, GatewayPathInfoResponseHandler, GDALModule, HDF4Module, HDF5Module, http::EffectiveUrlCache, http::HttpError, httpd_catalog::HttpdCatalog, httpd_catalog::HttpdCatalogContainer, httpd_catalog::HttpdCatalogContainerStorage, httpd_catalog::HttpdCatalogError, httpd_catalog::HttpdCatalogModule, ncml_module::NCMLModule, ncml_module::NCMLRequestHandler, NCModule, ngap::NgapModule, ngap::NgapOwnedContainer, ngap::NgapOwnedContainerStorage, ngap::NgapRequestHandler, PPTClient, PPTConnection, PPTServer, s3::S3Container, s3::S3ContainerStorage, s3::S3Module, s3::S3RequestHandler, SampleModule, SampleRequestHandler, SampleSayResponseHandler, SampleSayXMLCommand, SayReporter, ServerApp, ServerHandler, ShowBesKeyCommand, ShowBesKeyResponseHandler, ShowPathInfoCommand, ShowPathInfoResponseHandler, SiteMapCommand, SiteMapResponseHandler, Socket, SocketListener, StandAloneApp, StandAloneClient, TcpSocket, TheBESKeys, UgridFunctions, UnixSocket, W10nJsonRequestHandler, W10nJsonTransform, W10NModule, W10nShowPathInfoCommand, and W10nShowPathInfoResponseHandler.

◆ dump() [2/2]

void FONcTransform::dump ( ostream & strm) const
virtual

dumps information about this transformation object for debugging purposes

Displays the pointer value of this instance plus instance data, including all of the FONc objects converted from DAP objects that are to be sent to the netcdf file.

Parameters
strmC++ i/o stream to dump the information to

Definition at line 1548 of file FONcTransform.cc.

◆ get_gdio_flag()

bool FONcTransform::get_gdio_flag ( ) const
inline

Definition at line 93 of file FONcTransform.h.

◆ set_gdio_flag()

void FONcTransform::set_gdio_flag ( bool dio_flag_value = true)
inline

Definition at line 94 of file FONcTransform.h.

◆ transform_dap2()

void FONcTransform::transform_dap2 ( )
virtual

Transforms each of the variables of the DataDDS to the NetCDF file.

For each variable in the DataDDS write out that variable and its attributes to the netcdf file. Each OPeNDAP data type translates into a particular netcdf type. Also write out any global variables stored at the top level of the DataDDS.

Definition at line 283 of file FONcTransform.cc.

◆ transform_dap4()

void FONcTransform::transform_dap4 ( )
virtual

Transforms each of the variables of the DMR to the NetCDF file.

For each variable in the DMR write out that variable and its attributes to the netcdf file. Each OPeNDAP data type translates into a particular netcdf type. Also write out any global variables stored at the top level of the DMR.

Definition at line 531 of file FONcTransform.cc.

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