FONcBaseType.cc

Go to the documentation of this file.

// FONcBaseType.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 <BESDebug.h>

#include "FONcBaseType.h"
#include "FONcUtils.h"

#define RETURNAS_NETCDF "netcdf"
#define RETURNAS_NETCDF4 "netcdf-4"

void
FONcBaseType::convert( vector<string> embed )
{
    _embed = embed ;
    _varname = name() ;
}

void
FONcBaseType::define( int ncid )
{
    if( !_defined )
    {
        _varname = FONcUtils::gen_name( _embed, _varname, _orig_varname ) ;
        BESDEBUG( "fonc", "FONcBaseType::define - defining "
                          << _varname << endl ) ;
        int stax = nc_def_var( ncid, _varname.c_str(), type(),
                               0, NULL, &_varid ) ;
        if( stax != NC_NOERR )
        {
            string err = (string)"fileout.netcdf - "
                         + "Failed to define variable "
                         + _varname ;
            FONcUtils::handle_error( stax, err, __FILE__, __LINE__ ) ;
        }

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

nc_type
FONcBaseType::type()
{
    return NC_NAT ; // the constant ncdf uses to define simple type
}

void
FONcBaseType::clear_embedded()
{
    _embed.clear() ;
}

void FONcBaseType::setVersion(string version)
{
        _ncVersion = version;

        BESDEBUG( "fonc", "FONcBaseType::setVersion: "
                        << _ncVersion << endl ) ;
}

bool FONcBaseType::isNetCDF4()
{

        int stax = NC_NOERR;

        if ( FONcBaseType::_ncVersion == RETURNAS_NETCDF4 ) {
                return true;
        }

        if ( FONcBaseType::_ncVersion == RETURNAS_NETCDF ) {
                return false;
        }
        else {
                string err = (string)"fileout.netcdf - "
                                         + "Failed to define netcdf version: variable "
                                         + _varname ;
                FONcUtils::handle_error( stax, err, __FILE__, __LINE__ ) ;

                return false;
        }
}