bes  Updated for version 3.20.5
BESContainerStorage.h
1 // BESContainerStorage.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 BESContainerStorage_h_
34 #define BESContainerStorage_h_ 1
35 
36 #include <string>
37 #include <list>
38 #include <ostream>
39 
40 #if 0
41 using std::std::string;
42 using std::list;
43 #endif
44 
45 #include "BESObj.h"
46 
47 class BESContainer;
48 class BESInfo;
49 
72 class BESContainerStorage: public BESObj {
73 protected:
74  std::string _my_name;
75  virtual void show_container(const std::string &sym_name, const std::string &real_name, const std::string &type, BESInfo &info);
76 
77 public:
83  BESContainerStorage(const std::string &name) :
84  _my_name(name)
85  {
86  }
87 
88  virtual ~BESContainerStorage()
89  {
90  }
91 
96  virtual const std::string & get_name() const
97  {
98  return _my_name;
99  }
100 
109  virtual BESContainer * look_for(const std::string &sym_name) = 0;
110 
122  virtual void add_container(const std::string &sym_name, const std::string &real_name, const std::string &type) = 0;
123 
129  virtual void add_container(BESContainer *c) = 0;
130 
139  virtual bool del_container(const std::string &s_name) = 0;
140 
148  virtual bool del_containers() = 0;
149 
157  virtual bool isData(const std::string &inQuestion, std::list<std::string> &provides) = 0;
158 
169  virtual void show_containers(BESInfo &info) = 0;
170 
175  virtual void dump(std::ostream &strm) const = 0;
176 };
177 
178 #endif // BESContainerStorage_h_
provides persistent storage for data storage information represented by a container.
BESContainerStorage(const std::string &name)
create an instance of BESContainerStorage with the given name.
virtual BESContainer * look_for(const std::string &sym_name)=0
looks for a container in this persistent store
Base object for bes objects.
Definition: BESObj.h:51
virtual void show_containers(BESInfo &info)=0
show the containers stored in this persistent store
informational response object
Definition: BESInfo.h:68
virtual bool del_container(const std::string &s_name)=0
removes a container with the given symbolic name
virtual bool del_containers()=0
removes all container
virtual void show_container(const std::string &sym_name, const std::string &real_name, const std::string &type, BESInfo &info)
add information for a container to the informational response object
virtual bool isData(const std::string &inQuestion, std::list< std::string > &provides)=0
determine if the given container is data and what services are available for it
virtual void add_container(const std::string &sym_name, const std::string &real_name, const std::string &type)=0
adds a container with the provided information
A container is something that holds data. E.G., a netcdf file or a database entry.
Definition: BESContainer.h:68
virtual void dump(std::ostream &strm) const =0
Displays debug information about this object.
virtual const std::string & get_name() const
retrieve the name of this persistent store