Grid/AttributedGridFunctions.hpp

Go to the documentation of this file.

/* 
 * AttributedGridFunctions.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * 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 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; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_GRID_ATTRIBUTEDGRIDFUNCTIONS_HPP
#define CDPL_GRID_ATTRIBUTEDGRIDFUNCTIONS_HPP
 
#include <string>
 
#include "CDPL/Grid/APIPrefix.hpp"
 
 
namespace CDPL
{
 
    namespace Grid
    {
 
        class AttributedGrid;
 
        CDPL_GRID_API const std::string& getName(const AttributedGrid& grid);
 
        CDPL_GRID_API void setName(AttributedGrid& grid, const std::string& name);
 
        CDPL_GRID_API void clearName(AttributedGrid& grid);
 
        CDPL_GRID_API bool hasName(const AttributedGrid& grid);
 
        CDPL_GRID_API const std::string& getComment(const AttributedGrid& grid);
 
        CDPL_GRID_API void setComment(AttributedGrid& grid, const std::string& comment);
 
        CDPL_GRID_API void clearComment(AttributedGrid& grid);
 
        CDPL_GRID_API bool hasComment(const AttributedGrid& grid);
        
    } // namespace Grid
} // namespace CDPL
 
#endif // CDPL_GRID_ATTRIBUTEDGRIDFUNCTIONS_HPP