OPeNDAP Hyrax Back End Server (BES)  Updated for version 3.8.3
BESContainer.h
Go to the documentation of this file.
1 // BESContainer.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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 BESContainer_h_
34 #define BESContainer_h_ 1
35 
36 #include <list>
37 #include <string>
38 
39 using std::list ;
40 using std::string ;
41 
42 #include "BESObj.h"
43 
60 class BESContainer : public BESObj
61 {
62 private:
63  string _symbolic_name ;
64  string _real_name ;
65  string _container_type ;
66  string _constraint ;
67  string _attributes ;
68  protected:
70 
78  BESContainer( const string &sym_name,
79  const string &real_name,
80  const string &type )
81  : _symbolic_name( sym_name ),
82  _real_name( real_name ),
83  _container_type( type )
84  {}
85 
86  BESContainer( const BESContainer &copy_from ) ;
87 
88 
89  void _duplicate( BESContainer &copy_to ) ;
90  public:
91 
92  virtual ~BESContainer() {}
93 
96  virtual BESContainer * ptr_duplicate( ) = 0 ;
97 
102  void set_constraint( const string &s )
103  {
104  _constraint = s ;
105  }
106 
112  void set_real_name( const string &real_name )
113  {
114  _real_name = real_name ;
115  }
116 
122  void set_container_type( const string &type )
123  {
124  _container_type = type ;
125  }
126 
131  void set_attributes( const string &attrs )
132  {
133  _attributes = attrs ;
134  }
135 
141  string get_real_name() const
142  {
143  return _real_name ;
144  }
145 
150  string get_constraint() const
151  {
152  return _constraint ;
153  }
154 
159  string get_symbolic_name() const
160  {
161  return _symbolic_name ;
162  }
163 
170  string get_container_type() const
171  {
172  return _container_type ;
173  }
174 
179  string get_attributes() const
180  {
181  return _attributes ;
182  }
183 
195  virtual string access() = 0 ;
196  virtual bool release() = 0 ;
197 
198  virtual void dump( ostream &strm ) const ;
199 };
200 
201 #endif // BESContainer_h_
202 
void set_real_name(const string &real_name)
set the real name for this container, such as a file name if reading a data file. ...
Definition: BESContainer.h:112
virtual ~BESContainer()
Definition: BESContainer.h:92
BESContainer(const string &sym_name, const string &real_name, const string &type)
construct a container with the given symbolic name, real name and container type. ...
Definition: BESContainer.h:78
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BESContainer.cc:71
virtual string access()=0
returns the true name of this container
Base object for bes objects.
Definition: BESObj.h:52
void set_container_type(const string &type)
set the type of data that this container represents, such as cedar or netcdf.
Definition: BESContainer.h:122
virtual bool release()=0
void set_constraint(const string &s)
set the constraint for this container
Definition: BESContainer.h:102
void _duplicate(BESContainer &copy_to)
duplicate this instance into the passed container
Definition: BESContainer.cc:54
void set_attributes(const string &attrs)
set desired attributes for this container
Definition: BESContainer.h:131
string get_constraint() const
retrieve the constraint expression for this container
Definition: BESContainer.h:150
string get_real_name() const
retreive the real name for this container, such as a file name.
Definition: BESContainer.h:141
string get_container_type() const
retrieve the type of data this container holds, such as cedar or netcdf.
Definition: BESContainer.h:170
A container is something that holds data.
Definition: BESContainer.h:60
string get_attributes() const
retrieve the attributes desired from this container
Definition: BESContainer.h:179
virtual BESContainer * ptr_duplicate()=0
pure abstract method to duplicate this instances of BESContainer
string get_symbolic_name() const
retrieve the symbolic name for this container
Definition: BESContainer.h:159