AggMemberDataset.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__AGG_MEMBER_DATASET_H__
#define __AGG_UTIL__AGG_MEMBER_DATASET_H__

#include "Dimension.h" // agg_util
#include "RCObject.h"
#include <string>
#include <vector>

namespace libdap
{
  class DataDDS;
  class DDS;
};

using libdap::DataDDS;
using libdap::DDS;

namespace agg_util
{
  class AggMemberDataset : public RCObject
  {
  public:
    AggMemberDataset(const std::string& location);
    virtual ~AggMemberDataset();

    AggMemberDataset& operator=(const AggMemberDataset& rhs);
    AggMemberDataset(const AggMemberDataset& proto);

    const std::string& getLocation() const;

    virtual const libdap::DataDDS* getDataDDS() = 0;

    // TODO Consider adding freeDataDDS() or equivalent
    // to clear the memory made by getDataDDS if it was
    // loaded so we can tighten up the memory usage
    // for large AMD Lists.

    virtual unsigned int getCachedDimensionSize(const std::string& dimName) const = 0;

    virtual bool isDimensionCached(const std::string& dimName) const = 0;

    virtual void setDimensionCacheFor(const Dimension& dim, bool throwIfFound) = 0;

    virtual void fillDimensionCacheByUsingDataDDS() = 0;

    virtual void flushDimensionCache() = 0;

    virtual void saveDimensionCache(std::ostream& ostr) = 0;

    virtual void loadDimensionCache(std::istream& istr) = 0;

  private: // data rep
    std::string _location; // non-empty location from which to load DataDDS
  };

  // List is ref-counted ptrs to AggMemberDataset concrete subclasses.
  typedef std::vector< RCPtr<AggMemberDataset> > AMDList;

}; // namespace agg_util

#endif /* __AGG_UTIL__AGG_MEMBER_DATASET_H__ */