FONcStr.cc

Go to the documentation of this file.

// FONcStr.cc

// This file is part of BES Netcdf File Out Module

// Copyright (c) 2004,2005 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301

// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>

#include <BESInternalError.h>
#include <BESDebug.h>

#include "FONcStr.h"
#include "FONcUtils.h"
#include "FONcAttributes.h"

FONcStr::FONcStr( BaseType *b )
    : FONcBaseType(), _str( 0 ), _dimid( 0 ), _data( 0 )
{
    _str = dynamic_cast<Str *>(b) ;
    if( !_str )
    {
        string s = (string)"File out netcdf, FONcStr was passed a "
                   + "variable that is not a DAP Str" ;
        throw BESInternalError( s, __FILE__, __LINE__ ) ;
    }
}

FONcStr::~FONcStr()
{
    if( _data ) delete _data ;
}

void
FONcStr::define( int ncid )
{
    if( !_defined )
    {
        BESDEBUG( "fonc", "FONcStr::define - defining "
                          << _varname << endl ) ;

        int var_dims[1] ;               // variable shape
        // size_t var_start[1] ;        // variable start     // Not used; jhrg 3/16/11
        // size_t var_count[1] ;        // variable count     // Not used; jhrg 3/16/11

        _varname = FONcUtils::gen_name( _embed, _varname, _orig_varname ) ;
        _data = new string ;
        _str->buf2val( (void**)&_data ) ;
        int size = _data->size() + 1 ;

        string dimname = _varname + "_len" ;
        int stax = nc_def_dim( ncid, dimname.c_str(), size, &_dimid ) ;
        if( stax != NC_NOERR )
        {
            string err = (string)"fileout.netcdf - "
                         + "Failed to define dim " + dimname + " for "
                         + _varname ;
            FONcUtils::handle_error( stax, err, __FILE__, __LINE__ ) ;
        }

        var_dims[0] = _dimid ;
        stax = nc_def_var( ncid, _varname.c_str(), NC_CHAR, 1,
                           var_dims, &_varid );
        if( stax != NC_NOERR )
        {
            string err = (string)"fileout.netcdf - "
                         + "Failed to define var " + _varname ;
            FONcUtils::handle_error( stax, err, __FILE__, __LINE__ ) ;
        }

        _defined = true ;

        FONcAttributes::add_attributes( ncid, _varid, _str ) ;
        FONcAttributes::add_original_name( ncid, _varid,
                                           _varname, _orig_varname ) ;

        BESDEBUG( "fonc", "FONcStr::define - done defining "
                          << _varname << endl ) ;
    }
}

void
FONcStr::write( int ncid )
{
    BESDEBUG( "fonc", "FONcStr::write for var " << _varname << endl ) ;

    size_t var_start[1] ;       // variable start
    size_t var_count[1] ;       // variable count

    var_count[0] = _data->size() + 1 ;
    var_start[0] = 0 ;
    int stax = nc_put_vara_text( ncid, _varid, var_start, var_count, 
                                 _data->c_str() ) ;
    if( stax != NC_NOERR )
    {
        string err = (string)"fileout.netcdf - "
                     + "Failed to write string data " + *_data + " for "
                     + _varname ;
        delete _data ;
        _data = 0 ;
        FONcUtils::handle_error( stax, err, __FILE__, __LINE__ ) ;
    }
    delete _data ;
    _data = 0 ;
    BESDEBUG( "fonc", "FONcStr::done write for var " << _varname << endl ) ;
}

string
FONcStr::name()
{
    return _str->name() ;
}

nc_type
FONcStr::type()
{
    return NC_CHAR ;
}

void
FONcStr::dump( ostream &strm ) const
{
    strm << BESIndent::LMarg << "FONcStr::dump - ("
                             << (void *)this << ")" << endl ;
    BESIndent::Indent() ;
    strm << BESIndent::LMarg << "name = " << _str->name()  << endl ;
    BESIndent::UnIndent() ;
}