bes  Updated for version 3.20.6
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 #include "BESObj.h"
41 
42 class BESContainer;
43 class BESInfo;
44 
67 class BESContainerStorage: public BESObj {
68 protected:
69  std::string _my_name;
70  virtual void show_container(const std::string &sym_name, const std::string &real_name, const std::string &type, BESInfo &info);
71 
72 public:
78  BESContainerStorage(const std::string &name) :
79  _my_name(name)
80  {
81  }
82 
83  virtual ~BESContainerStorage()
84  {
85  }
86 
91  virtual const std::string & get_name() const
92  {
93  return _my_name;
94  }
95 
104  virtual BESContainer * look_for(const std::string &sym_name) = 0;
105 
117  virtual void add_container(const std::string &sym_name, const std::string &real_name, const std::string &type) = 0;
118 
124  virtual void add_container(BESContainer *c) = 0;
125 
134  virtual bool del_container(const std::string &s_name) = 0;
135 
143  virtual bool del_containers() = 0;
144 
152  virtual bool isData(const std::string &inQuestion, std::list<std::string> &provides) = 0;
153 
164  virtual void show_containers(BESInfo &info) = 0;
165 
170  virtual void dump(std::ostream &strm) const = 0;
171 };
172 
173 #endif // BESContainerStorage_h_
BESContainerStorage
provides persistent storage for data storage information represented by a container.
Definition: BESContainerStorage.h:67
BESInfo
informational response object
Definition: BESInfo.h:63
BESContainerStorage::dump
virtual void dump(std::ostream &strm) const =0
Displays debug information about this object.
BESContainerStorage::look_for
virtual BESContainer * look_for(const std::string &sym_name)=0
looks for a container in this persistent store
BESContainerStorage::get_name
virtual const std::string & get_name() const
retrieve the name of this persistent store
Definition: BESContainerStorage.h:91
BESContainerStorage::BESContainerStorage
BESContainerStorage(const std::string &name)
create an instance of BESContainerStorage with the given name.
Definition: BESContainerStorage.h:78
BESContainerStorage::del_containers
virtual bool del_containers()=0
removes all container
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESContainerStorage::add_container
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
BESContainerStorage::show_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
Definition: BESContainerStorage.cc:48
BESContainerStorage::isData
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
BESContainerStorage::show_containers
virtual void show_containers(BESInfo &info)=0
show the containers stored in this persistent store
BESContainer
A container is something that holds data. E.G., a netcdf file or a database entry.
Definition: BESContainer.h:65
BESContainerStorage::del_container
virtual bool del_container(const std::string &s_name)=0
removes a container with the given symbolic name