bes  Updated for version 3.20.6
AggMemberDataset.h
1 // This file is part of the "NcML Module" project, a BES module designed
3 // to allow NcML files to be used to be used as a wrapper to add
4 // AIS to existing datasets of any format.
5 //
6 // Copyright (c) 2010 OPeNDAP, Inc.
7 // Author: Michael Johnson <m.johnson@opendap.org>
8 //
9 // For more information, please also see the main website: http://opendap.org/
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License along with this library; if not, write to the Free Software
23 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 //
25 // Please see the files COPYING and COPYRIGHT for more information on the GLPL.
26 //
27 // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
29 #ifndef __AGG_UTIL__AGG_MEMBER_DATASET_H__
30 #define __AGG_UTIL__AGG_MEMBER_DATASET_H__
31 
32 #include "Dimension.h" // agg_util
33 #include "RCObject.h"
34 #include <string>
35 #include <vector>
36 
37 namespace libdap {
38 class DDS;
39 }
40 
41 using libdap::DDS;
42 
43 namespace agg_util {
63 class AggMemberDataset: public RCObject {
64 public:
65  AggMemberDataset(const std::string& location);
66  virtual ~AggMemberDataset();
67 
68  AggMemberDataset& operator=(const AggMemberDataset& rhs);
69  AggMemberDataset(const AggMemberDataset& proto);
70 
74  const std::string& getLocation() const;
75 
83  virtual const libdap::DDS* getDDS() = 0;
84 
85  // TODO Consider adding freeDDS() or equivalent
86  // to clear the memory made by getDDS if it was
87  // loaded so we can tighten up the memory usage
88  // for large AMD Lists.
89 
106  virtual unsigned int getCachedDimensionSize(const std::string& dimName) const = 0;
107 
110  virtual bool isDimensionCached(const std::string& dimName) const = 0;
111 
126  virtual void setDimensionCacheFor(const Dimension& dim, bool throwIfFound) = 0;
127 
134  virtual void fillDimensionCacheByUsingDDS() = 0;
135 
140  virtual void flushDimensionCache() = 0;
141 
143  virtual void saveDimensionCache(std::ostream& ostr) = 0;
144 
146  virtual void loadDimensionCache(std::istream& istr) = 0;
147 
148 
149 private:
150  // data rep
151  std::string _location; // non-empty location from which to load DDS
152 };
153 
154 // List is ref-counted ptrs to AggMemberDataset concrete subclasses.
155 typedef std::vector<RCPtr<AggMemberDataset> > AMDList;
156 
157 }
158 ;
159 // namespace agg_util
160 
161 #endif /* __AGG_UTIL__AGG_MEMBER_DATASET_H__ */
agg_util::AggMemberDataset::flushDimensionCache
virtual void flushDimensionCache()=0
agg_util::AggMemberDataset::getDDS
virtual const libdap::DDS * getDDS()=0
agg_util::Dimension
Definition: Dimension.h:49
agg_util::AggMemberDataset::fillDimensionCacheByUsingDDS
virtual void fillDimensionCacheByUsingDDS()=0
agg_util::AggMemberDataset::loadDimensionCache
virtual void loadDimensionCache(std::istream &istr)=0
agg_util
Helper class for temporarily hijacking an existing dhi to load a DDX response for one particular file...
Definition: AggMemberDataset.cc:38
agg_util::AggMemberDataset::isDimensionCached
virtual bool isDimensionCached(const std::string &dimName) const =0
libdap
Definition: BESDapFunctionResponseCache.h:35
agg_util::AggMemberDataset::getCachedDimensionSize
virtual unsigned int getCachedDimensionSize(const std::string &dimName) const =0
agg_util::RCObject
A base class for a simple reference counted object.
Definition: RCObject.h:164
agg_util::AggMemberDataset
Definition: AggMemberDataset.h:63
agg_util::AggMemberDataset::setDimensionCacheFor
virtual void setDimensionCacheFor(const Dimension &dim, bool throwIfFound)=0
agg_util::AggMemberDataset::saveDimensionCache
virtual void saveDimensionCache(std::ostream &ostr)=0
agg_util::AggMemberDataset::getLocation
const std::string & getLocation() const
Definition: AggMemberDataset.cc:62