GridAggregationBase.h

Go to the documentation of this file.

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2010 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.

#ifndef __AGG_UTIL__GRID_AGGREGATION_BASE_H__
#define __AGG_UTIL__GRID_AGGREGATION_BASE_H__

#include "AggMemberDataset.h" // agg_util
#include "DDSLoader.h" // agg_util
#include <Grid.h> // libdap
#include <memory> // std

namespace libdap
{
  class Array;
  class Grid;
  class D4Group;
};

namespace agg_util
{

  class GridAggregationBase : public libdap::Grid
  {
  public:
    GridAggregationBase(const libdap::Grid& proto,
        const AMDList& memberDatasets,
        const DDSLoader& loaderProto);

    GridAggregationBase(const string& name,
        const AMDList& memberDatasets,
        const DDSLoader& loaderProto);

    GridAggregationBase(const GridAggregationBase& proto);

    virtual ~GridAggregationBase();

    GridAggregationBase& operator=(const GridAggregationBase& rhs);
#if 1
    BaseType *transform_to_dap4(libdap::D4Group *root, libdap::Constructor *container);
#endif

    void setShapeFrom(const libdap::Grid& protoSubGrid, bool addMaps);

    virtual const AMDList& getDatasetList() const;

    virtual bool read();

  protected: // subclass interface

    virtual void readAndAggregateConstrainedMapsHook();

    Grid* getSubGridTemplate();

    virtual const Dimension& getAggregationDimension() const = 0;

    void printConstraints(const libdap::Array& fromArray);


    void readProtoSubGrid();

    // Support calls for the read()....

    void copyProtoMapsIntoThisGrid(const Dimension& aggDim);

    virtual void transferConstraintsToSubGridHook(Grid* pSubGrid);

  private: // helpers

    void duplicate(const GridAggregationBase& rhs);

    void cleanup() throw();

    static libdap::Grid* cloneSubGridProto(const libdap::Grid& proto);


  private: // data rep

    // Use this to laod the member datasets as needed
    DDSLoader _loader;

    // A template for the unaggregated (sub) Grids.
    // It will be used to validate other datasets as they are loaded.
    std::auto_ptr<Grid> _pSubGridProto;

    // Maintain a copy here... we may want to move this down...
    AMDList _memberDatasets;

  }; // class GridAggregationBase

} // namespace agg_util

#endif /* __AGG_UTIL__GRID_AGGREGATION_BASE_H__ */