libdap Updated for version 3.21.1
libdap4 is an implementation of OPeNDAP's DAP protocol.
Public Member Functions | List of all members
libdap::BaseTypeFactory Class Reference

#include <BaseTypeFactory.h>

Inheritance diagram for libdap::BaseTypeFactory:
Inheritance graph
Collaboration diagram for libdap::BaseTypeFactory:
Collaboration graph

Public Member Functions

 BaseTypeFactory ()
 
virtual Array * NewArray (const string &n="", BaseType *v=0) const
 
virtual Byte * NewByte (const string &n="") const
 
virtual Float32 * NewFloat32 (const string &n="") const
 
virtual Float64 * NewFloat64 (const string &n="") const
 
virtual Grid * NewGrid (const string &n="") const
 
virtual Int16 * NewInt16 (const string &n="") const
 
virtual Int32 * NewInt32 (const string &n="") const
 
virtual Sequence * NewSequence (const string &n="") const
 
virtual Str * NewStr (const string &n="") const
 
virtual Structure * NewStructure (const string &n="") const
 
virtual UInt16 * NewUInt16 (const string &n="") const
 
virtual UInt32 * NewUInt32 (const string &n="") const
 
virtual Url * NewUrl (const string &n="") const
 
virtual BaseType * NewVariable (Type t, const string &name="") const
 
virtual BaseTypeFactory * ptr_duplicate () const
 
virtual ~BaseTypeFactory ()
 

Detailed Description

A factory to create instances of the leaf nodes of BaseType (Byte, ... Grid). Clients of libdap++ which require special behavior for the types should subclass this factory and provide an implementation which creates instances of those specializations. Make sure to pass a reference to the new factory to DDS's constructor since by default it uses this factory.

To define and use your own factory, first make sure that you are not using the compile time constant 'DEFAULT_BASETYPE_FACTORY.' Then pass a pointer to an instance of your factory to the DDS/DataDDS constructors. When the parser is used to build a DDS from a DAP response, the factory will be used to instantiate the different variable-type classes.

Note
The easiest way to subclass this is to follow the pattern of using a separate class declaration and implementation. It's possible to use one file to hold both, but that is complicated somewhat because DDS.h, which includes this class, also includes many of the type classes (Array.h, ..., Grid.h) and the order of their inclusion can create compilation problems where the Vector and/or Constructor base classes are not defined. It's easiest to split the declaration and implementation and include forward declarations of the type classes in the declaration (.h) file and then include the type class' headers in the implementation (.cc) file.
Author
James Gallagher
See also
DDS

Definition at line 79 of file BaseTypeFactory.h.

Constructor & Destructor Documentation

◆ BaseTypeFactory()

libdap::BaseTypeFactory::BaseTypeFactory ( )
inline

Definition at line 81 of file BaseTypeFactory.h.

◆ ~BaseTypeFactory()

virtual libdap::BaseTypeFactory::~BaseTypeFactory ( )
inlinevirtual

Definition at line 82 of file BaseTypeFactory.h.

Member Function Documentation

◆ NewArray()

Array * libdap::BaseTypeFactory::NewArray ( const string & n = "",
BaseType * v = 0 ) const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 105 of file BaseTypeFactory.cc.

◆ NewByte()

Byte * libdap::BaseTypeFactory::NewByte ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 84 of file BaseTypeFactory.cc.

◆ NewFloat32()

Float32 * libdap::BaseTypeFactory::NewFloat32 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 97 of file BaseTypeFactory.cc.

◆ NewFloat64()

Float64 * libdap::BaseTypeFactory::NewFloat64 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 99 of file BaseTypeFactory.cc.

◆ NewGrid()

Grid * libdap::BaseTypeFactory::NewGrid ( const string & n = "") const
virtual

Definition at line 114 of file BaseTypeFactory.cc.

◆ NewInt16()

Int16 * libdap::BaseTypeFactory::NewInt16 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 86 of file BaseTypeFactory.cc.

◆ NewInt32()

Int32 * libdap::BaseTypeFactory::NewInt32 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 90 of file BaseTypeFactory.cc.

◆ NewSequence()

Sequence * libdap::BaseTypeFactory::NewSequence ( const string & n = "") const
virtual

Definition at line 109 of file BaseTypeFactory.cc.

◆ NewStr()

Str * libdap::BaseTypeFactory::NewStr ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 101 of file BaseTypeFactory.cc.

◆ NewStructure()

Structure * libdap::BaseTypeFactory::NewStructure ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 107 of file BaseTypeFactory.cc.

◆ NewUInt16()

UInt16 * libdap::BaseTypeFactory::NewUInt16 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 88 of file BaseTypeFactory.cc.

◆ NewUInt32()

UInt32 * libdap::BaseTypeFactory::NewUInt32 ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 95 of file BaseTypeFactory.cc.

◆ NewUrl()

Url * libdap::BaseTypeFactory::NewUrl ( const string & n = "") const
virtual

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 103 of file BaseTypeFactory.cc.

◆ NewVariable()

BaseType * libdap::BaseTypeFactory::NewVariable ( Type t,
const string & name = "" ) const
virtual

Build a new variable and return it using a BaseType pointer. The type of the variable is given using Type enumeration.

Note
Added for DAP4
Parameters
tThe type of the variable to create @parma name The (optional) name of the variable.

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 49 of file BaseTypeFactory.cc.

◆ ptr_duplicate()

virtual BaseTypeFactory * libdap::BaseTypeFactory::ptr_duplicate ( ) const
inlinevirtual

Clone this object and return a pointer to the clone.

Note
added for DAP4

Reimplemented in libdap::D4BaseTypeFactory.

Definition at line 100 of file BaseTypeFactory.h.

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