bes  Updated for version 3.20.6
BESDefinitionStorage.h
1 // BESDefinitionStorage.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 BESDefinitionStorage_h_
34 #define BESDefinitionStorage_h_ 1
35 
36 #include <string>
37 
38 #include "BESObj.h"
39 
40 class BESDefine ;
41 class BESInfo ;
42 
63 {
64 protected:
65  std::string _my_name ;
66 
67 public:
73  BESDefinitionStorage( const std::string &name )
74  : _my_name( name ) {} ;
75 
76  virtual ~BESDefinitionStorage() {} ;
77 
82  virtual const std::string & get_name() const { return _my_name ; }
83 
90  virtual BESDefine * look_for( const std::string &def_name ) = 0 ;
91 
102  virtual bool add_definition( const std::string &def_name,
103  BESDefine *d ) = 0 ;
104 
113  virtual bool del_definition( const std::string &def_name ) = 0 ;
114 
119  virtual bool del_definitions( ) = 0 ;
120 
131  virtual void show_definitions( BESInfo &info ) = 0 ;
132 
137  virtual void dump( std::ostream &strm ) const = 0 ;
138 };
139 
140 #endif // BESDefinitionStorage_h_
141 
BESDefinitionStorage
provides persistent storage for a specific view of different containers including contraints and aggr...
Definition: BESDefinitionStorage.h:62
BESDefinitionStorage::get_name
virtual const std::string & get_name() const
retrieve the name of this persistent store
Definition: BESDefinitionStorage.h:82
BESDefinitionStorage::add_definition
virtual bool add_definition(const std::string &def_name, BESDefine *d)=0
adds a given definition to this storage
BESDefinitionStorage::dump
virtual void dump(std::ostream &strm) const =0
Displays debug information about this object.
BESDefinitionStorage::look_for
virtual BESDefine * look_for(const std::string &def_name)=0
looks for a definition in this persistent store with the given name
BESInfo
informational response object
Definition: BESInfo.h:63
BESDefinitionStorage::del_definitions
virtual bool del_definitions()=0
deletes all defintions from the definition store
BESDefine
Definition: BESDefine.h:42
BESDefinitionStorage::del_definition
virtual bool del_definition(const std::string &def_name)=0
deletes a defintion with the given name
BESObj
top level BES object to house generic methods
Definition: BESObj.h:49
BESDefinitionStorage::BESDefinitionStorage
BESDefinitionStorage(const std::string &name)
create an instance of BESDefinitionStorage with the give name.
Definition: BESDefinitionStorage.h:73
BESDefinitionStorage::show_definitions
virtual void show_definitions(BESInfo &info)=0
show the defintions stored in this store