bes  Updated for version 3.20.6
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 #include "BESContainer.h"
40 
57 private:
58  bool _cached;
59  std::string _target;
60 
61  BESFileContainer() : BESContainer(), _cached(false), _target("")
62  {
63  }
64 
65 protected:
66  virtual void _duplicate(BESContainer &copy_to);
67 
68 public:
69  static const std::string UNCOMPRESS_CACHE_DIR_KEY;
70  static const std::string UNCOMPRESS_CACHE_PREFIX_KEY;
71  static const std::string UNCOMPRESS_CACHE_SIZE_KEY;
72 
73  BESFileContainer(const std::string &sym_name, const std::string &real_name, const std::string &type);
74 
75  BESFileContainer(const BESFileContainer &copy_from);
76 
77  // TODO Make this distructor call the release() method? jhrg 7/25/18
78  virtual ~BESFileContainer()
79  {
80  }
81 
82  virtual BESContainer * ptr_duplicate();
83 
84  virtual std::string access();
85 
86  virtual bool release();
87 
92  virtual void dump(std::ostream &strm) const;
93 };
94 
95 #endif // BESFileContainer_h_
BESFileContainer
Holds real data, container type and constraint for symbolic name read from persistence.
Definition: BESFileContainer.h:56
BESFileContainer::ptr_duplicate
virtual BESContainer * ptr_duplicate()
duplicate this instances of BESFileContainer
Definition: BESFileContainer.cc:82
BESContainer
A container is something that holds data. E.G., a netcdf file or a database entry.
Definition: BESContainer.h:65
BESFileContainer::dump
virtual void dump(std::ostream &strm) const
Displays debug information about this object.
Definition: BESFileContainer.cc:142
BESFileContainer::release
virtual bool release()
release the file
Definition: BESFileContainer.cc:126
BESFileContainer::access
virtual std::string access()
returns the name of a file to access for this container, uncompressing if necessary.
Definition: BESFileContainer.cc:94