GridJoinExistingAggregation.h

// 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_JOIN_EXISTING_AGGREGATION_H__
#define __AGG_UTIL__GRID_JOIN_EXISTING_AGGREGATION_H__
 
#include "ArrayJoinExistingAggregation.h" //agg_util
#include "Dimension.h" // agg_util
#include "GridAggregationBase.h" // agg_util
#include <memory>
 
namespace agg_util {
class GridJoinExistingAggregation: public GridAggregationBase {
public:
 
    GridJoinExistingAggregation(const libdap::Grid& proto, const AMDList& memberDatasets, const DDSLoader& loaderProto,
        const Dimension& joinDim);
 
    GridJoinExistingAggregation(const GridJoinExistingAggregation& proto);
 
    virtual ~GridJoinExistingAggregation();
 
    virtual GridJoinExistingAggregation* ptr_duplicate();
 
    GridJoinExistingAggregation& operator=(const GridJoinExistingAggregation& rhs);

    unique_ptr<ArrayJoinExistingAggregation> makeAggregatedOuterMapVector() const;
 
protected:
    // subclass interface

    virtual void transferConstraintsToSubGridHook(Grid* pSubGrid);
 
    virtual const Dimension& getAggregationDimension() const;
 
private:
    // helpers

    void duplicate(const GridJoinExistingAggregation& rhs);

    void cleanup() const noexcept;

    void createRep(const libdap::Grid& protoSubGrid, const AMDList& granuleList);
 
    // Local helpers to implement transferConstraintsToSubGridHook()
    void transferConstraintsToSubGridMaps(Grid* pSubGrid);
    void transferConstraintsToSubGridArray(Grid* pSubGrid);
 
    // Data Rep
 
    Dimension _joinDim;
 
};
// class GridJoinExistingAggregation
}// namespace agg_util
 
#endif /* __AGG_UTIL__GRID_JOIN_EXISTING_AGGREGATION_H__ */