bes  Updated for version 3.20.5
BESFileContainer.h
1 // BESFileContainer.h
2 
3 // This file is part of bes, A C++ back-end server implementation framework
4 // for the OPeNDAP Data Access Protocol.
5 
6 // Copyright (c) 2004-2009 University Corporation for Atmospheric Research
7 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU Lesser General Public
11 // License as published by the Free Software Foundation; either
12 // version 2.1 of the License, or (at your option) any later version.
13 //
14 // This library is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // Lesser General Public License for more details.
18 //
19 // You should have received a copy of the GNU Lesser General Public
20 // License along with this library; if not, write to the Free Software
21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 //
23 // You can contact University Corporation for Atmospheric Research at
24 // 3080 Center Green Drive, Boulder, CO 80301
25 
26 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
27 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
28 //
29 // Authors:
30 // pwest Patrick West <pwest@ucar.edu>
31 // jgarcia Jose Garcia <jgarcia@ucar.edu>
32 
33 #ifndef BESFileContainer_h_
34 #define BESFileContainer_h_ 1
35 
36 #include <list>
37 #include <string>
38 
39 using std::list;
40 using std::string;
41 
42 #include "BESContainer.h"
43 
60 private:
61  bool _cached;
62  string _target;
63 
64  BESFileContainer() : BESContainer(), _cached(false), _target("")
65  {
66  }
67 
68 protected:
69  virtual void _duplicate(BESContainer &copy_to);
70 
71 public:
72  static const string UNCOMPRESS_CACHE_DIR_KEY;
73  static const string UNCOMPRESS_CACHE_PREFIX_KEY;
74  static const string UNCOMPRESS_CACHE_SIZE_KEY;
75 
76  BESFileContainer(const string &sym_name, const string &real_name, const string &type);
77 
78  BESFileContainer(const BESFileContainer &copy_from);
79 
80  // TODO Make this distructor call the release() method? jhrg 7/25/18
81  virtual ~BESFileContainer()
82  {
83  }
84 
85  virtual BESContainer * ptr_duplicate();
86 
87  virtual string access();
88 
89  virtual bool release();
90 
95  virtual void dump(ostream &strm) const;
96 };
97 
98 #endif // BESFileContainer_h_
BESFileContainer
Holds real data, container type and constraint for symbolic name read from persistence.
Definition: BESFileContainer.h:59
BESFileContainer::ptr_duplicate
virtual BESContainer * ptr_duplicate()
duplicate this instances of BESFileContainer
Definition: BESFileContainer.cc:78
BESFileContainer::dump
virtual void dump(ostream &strm) const
Displays debug information about this object.
Definition: BESFileContainer.cc:138
BESContainer
A container is something that holds data. E.G., a netcdf file or a database entry.
Definition: BESContainer.h:68
BESFileContainer::release
virtual bool release()
release the file
Definition: BESFileContainer.cc:122
BESFileContainer::access
virtual string access()
returns the name of a file to access for this container, uncompressing if necessary.
Definition: BESFileContainer.cc:90