bes  Updated for version 3.20.8
FONcStr.cc
1 // FONcStr.cc
2 
3 // This file is part of BES Netcdf File Out Module
4 
5 // Copyright (c) 2004,2005 University Corporation for Atmospheric Research
6 // Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
7 //
8 // This library is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU Lesser General Public
10 // License as published by the Free Software Foundation; either
11 // version 2.1 of the License, or (at your option) any later version.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Lesser General Public License for more details.
17 //
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 //
22 // You can contact University Corporation for Atmospheric Research at
23 // 3080 Center Green Drive, Boulder, CO 80301
24 
25 // (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
26 // Please read the full copyright statement in the file COPYRIGHT_UCAR.
27 //
28 // Authors:
29 // pwest Patrick West <pwest@ucar.edu>
30 // jgarcia Jose Garcia <jgarcia@ucar.edu>
31 
32 #include <sstream>
33 #include <Str.h>
34 
35 #include <BESInternalError.h>
36 #include <BESDebug.h>
37 
38 #include "FONcStr.h"
39 #include "FONcDim.h"
40 #include "FONcUtils.h"
41 #include "FONcAttributes.h"
42 
43 using namespace libdap;
44 
53 FONcStr::FONcStr(BaseType *b) :
54  FONcBaseType(), _str(0), _dimid(0), _data(0)
55 {
56  _str = dynamic_cast<Str *>(b);
57  if (!_str)
58  throw BESInternalError("File out netcdf, FONcStr was passed a variable that is not a DAP Str", __FILE__, __LINE__);
59 }
60 
69 {
70  delete _data;
71 }
72 
81 void FONcStr::define(int ncid)
82 {
83  if (!_defined) {
84  BESDEBUG("fonc", "FONcStr::define - defining " << _varname << endl);
85 
86  _varname = FONcUtils::gen_name(_embed, _varname, _orig_varname);
87  _data = new string;
88  _str->buf2val((void**) &_data);
89  int size = _data->size() + 1;
90 
91  string dimname;
92 
93  // For DAP4, we need to ensure the dimension name is unique.
94  if(is_dap4_group == true) {
95  ostringstream dim_suffix_strm;
96  dim_suffix_strm <<"_len"<<FONcDim::DimNameNum +1;
97  FONcDim::DimNameNum++;
98  dimname = _varname+dim_suffix_strm.str();
99  }
100  else
101  dimname = _varname + "_len";
102  int stax = nc_def_dim(ncid, dimname.c_str(), size, &_dimid);
103  if (stax != NC_NOERR) {
104  string err = (string) "fileout.netcdf - " + "Failed to define dim " + dimname + " for " + _varname;
105  FONcUtils::handle_error(stax, err, __FILE__, __LINE__);
106  }
107 
108  int var_dims[1]; // variable shape
109  var_dims[0] = _dimid;
110  stax = nc_def_var(ncid, _varname.c_str(), NC_CHAR, 1, var_dims, &_varid);
111  if (stax != NC_NOERR) {
112  string err = (string) "fileout.netcdf - " + "Failed to define var " + _varname;
113  FONcUtils::handle_error(stax, err, __FILE__, __LINE__);
114  }
115 
116  _defined = true;
117 
118  FONcAttributes::add_variable_attributes(ncid, _varid, _str,isNetCDF4_ENHANCED(),is_dap4);
119  FONcAttributes::add_original_name(ncid, _varid, _varname, _orig_varname);
120 
121  BESDEBUG("fonc", "FONcStr::define - done defining " << _varname << endl);
122  }
123 }
124 
134 void FONcStr::write(int ncid)
135 {
136  BESDEBUG("fonc", "FONcStr::write for var " << _varname << endl);
137 
138  size_t var_start[1]; // variable start
139  size_t var_count[1]; // variable count
140 
141  var_count[0] = _data->size() + 1;
142  var_start[0] = 0;
143  int stax = nc_put_vara_text(ncid, _varid, var_start, var_count, _data->c_str());
144  if (stax != NC_NOERR) {
145  string err = (string) "fileout.netcdf - " + "Failed to write string data " + *_data + " for " + _varname;
146  delete _data;
147  _data = 0;
148  FONcUtils::handle_error(stax, err, __FILE__, __LINE__);
149  }
150  delete _data;
151  _data = 0;
152 
153  BESDEBUG("fonc", "FONcStr::done write for var " << _varname << endl);
154 }
155 
161 {
162  return _str->name();
163 }
164 
169 nc_type FONcStr::type()
170 {
171  return NC_CHAR;
172 }
173 
180 void FONcStr::dump(ostream &strm) const
181 {
182  strm << BESIndent::LMarg << "FONcStr::dump - (" << (void *) this << ")" << endl;
183  BESIndent::Indent();
184  strm << BESIndent::LMarg << "name = " << _str->name() << endl;
185  BESIndent::UnIndent();
186 }
187 
exception thrown if internal error encountered
static void add_original_name(int ncid, int varid, const string &var_name, const string &orig)
Adds an attribute for the variable if the variable name had to be modified in any way.
static void add_variable_attributes(int ncid, int varid, BaseType *b, bool is_netCDF_enhanced, bool is_dap4)
Add the attributes for an OPeNDAP variable to the netcdf file.
A DAP BaseType with file out netcdf information included.
Definition: FONcBaseType.h:61
virtual nc_type type()
returns the netcdf type of the DAP Str
Definition: FONcStr.cc:169
virtual void define(int ncid)
Define the string variable in the netcdf file.
Definition: FONcStr.cc:81
virtual ~FONcStr()
Destructor that cleans up the str.
Definition: FONcStr.cc:68
virtual void write(int ncid)
Write the str out to the netcdf file.
Definition: FONcStr.cc:134
virtual void dump(ostream &strm) const
dumps information about this object for debugging purposes
Definition: FONcStr.cc:180
virtual string name()
returns the name of the DAP Str
Definition: FONcStr.cc:160
FONcStr(libdap::BaseType *b)
Constructor for FONcStr that takes a DAP Str.
Definition: FONcStr.cc:53
static void handle_error(int stax, const string &err, const string &file, int line)
handle any netcdf errors
Definition: FONcUtils.cc:399
static string gen_name(const vector< string > &embed, const string &name, string &original)
generate a new name for the embedded variable
Definition: FONcUtils.cc:189