GridAggregateOnOuterDimension.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) 2009 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_AGGREGATE_ON_OUTER_DIMENSION_H__
#define __AGG_UTIL__GRID_AGGREGATE_ON_OUTER_DIMENSION_H__

#include <memory>
#include <string>
#include <vector>

#include "AggregationUtil.h" // agg_util
#include "AggMemberDataset.h" // agg_util
#include "Dimension.h" // agg_util
#include "DDSLoader.h" // agg_util
#include <Grid.h> // libdap
#include "GridAggregationBase.h" // agg_util

namespace libdap
{
  class Array;
  class Grid;
};

using std::string;
using std::vector;
using libdap::Array;
using libdap::Grid;

namespace agg_util
{
  class GridAggregateOnOuterDimension : public GridAggregationBase
  {
  public:
    GridAggregateOnOuterDimension(const Grid& proto,
        const Dimension& newDim,
        const AMDList& memberDatasets,
        const DDSLoader& loaderProto);

    GridAggregateOnOuterDimension(const GridAggregateOnOuterDimension& proto);

    virtual ~GridAggregateOnOuterDimension();

    virtual GridAggregateOnOuterDimension* ptr_duplicate();

    GridAggregateOnOuterDimension& operator=(const GridAggregateOnOuterDimension& rhs);

  protected: // Subclass Impl

    virtual void transferConstraintsToSubGridHook(Grid* pSubGrid);

    virtual const Dimension& getAggregationDimension() const;


  private: // helpers

    void duplicate(const GridAggregateOnOuterDimension& rhs);

    void cleanup() throw();

    void createRep(const AMDList& memberDatasets);


    // Local helpers called from transferConstraintsToSubGridMapsHook()
    void transferConstraintsToSubGridMaps(Grid* pSubGrid);
    void transferConstraintsToSubGridArray(Grid* pSubGrid);

  private: // data rep
    // The new outer dimension description
    Dimension _newDim;

  };

}

#endif // __AGG_UTIL__GRID_AGGREGATE_ON_OUTER_DIMENSION_H__