NCMLUtil.h

Go to the documentation of this file.

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// 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
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
#ifndef __NCML_MODULE_NCML_UTIL_H__
#define __NCML_MODULE_NCML_UTIL_H__

namespace libdap
{
  // FDecls
  class BaseType;
  class Constructor;
  class DDS;
  class DAS;
  class AttrTable;
}

class BESDapResponse;

#include <string>
#include <vector>

// If there isn't one defined yet, define a safe delete
// to clear ptr after delete to avoid problems.
#ifndef SAFE_DELETE
#define SAFE_DELETE(a) { delete (a); (a) = 0; }
#endif // SAFE_DELETE

namespace ncml_module
{
  class NCMLUtil
  {
    NCMLUtil() {}
  public:
    ~NCMLUtil() {}

    static const std::string WHITESPACE;

    static int tokenize(
        const std::string& str,
        std::vector<std::string>& tokens,
        const std::string& delimiters = " \t");

    static int tokenizeChars(
        const std::string& str,
        std::vector<std::string>& tokens);

    static bool isAscii(const std::string& str);

    static bool isAllWhitespace(const std::string& str);

    static void trimLeft(
        std::string& str,
        const std::string& trimChars = WHITESPACE);

    static void trimRight(
        std::string& str,
        const std::string& trimChars = WHITESPACE);

    static void trim(
        std::string& str,
        const std::string& trimChars = WHITESPACE)
    {
      trimLeft(str, trimChars);
      trimRight(str, trimChars);
    }

    static void trimAll(
        std::vector<std::string>& tokens,
        const std::string& trimChars = WHITESPACE);


    static bool toUnsignedInt(const std::string& stringVal, unsigned int& oVal);

    static void populateDASFromDDS(libdap::DAS* das, const libdap::DDS& dds_const);

    static void copyVariablesAndAttributesInto(
        libdap::DDS* dds_out,
        const libdap::DDS& dds_in);

    static libdap::DDS* getDDSFromEitherResponse(BESDapResponse* response);

    static void hackGlobalAttributesForDAP2(libdap::AttrTable &global_attributes, const std::string &global_container_name);

    static void setVariableNameProperly(
        libdap::BaseType* pVar,
        const std::string& name);

  }; // class NCMLUtil
} // namespace ncml_module

#endif /* __NCML_MODULE_NCML_UTIL_H__ */