Console.h

Go to the documentation of this file.

/*********************************************************************
* Software License Agreement (BSD License)
*
*  Copyright (c) 2008, Willow Garage, Inc.
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*   * Neither the name of the Willow Garage nor the names of its
*     contributors may be used to endorse or promote products derived
*     from this software without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
*  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
*  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/

/* Author: Ioan Sucan */

#ifndef OMPL_UTIL_CONSOLE_
#define OMPL_UTIL_CONSOLE_

#include <string>
#include <cstdarg>

namespace ompl
{

    namespace msg
    {

        class Interface
        {
        public:

            explicit
            Interface(const std::string &prefix = "");
            virtual ~Interface(void);

            void setPrefix(const std::string &prefix);

            const std::string& getPrefix(void) const;

            void inform(const std::string &text) const;

            void warn(const std::string &text) const;

            void error(const std::string &text) const;

            void debug(const std::string &text) const;

            void inform(const char *msg, ...) const;

            void warn(const char *msg, ...) const;

            void error(const char *msg, ...) const;

            void debug(const char *msg, ...) const;

        protected:

            std::string prefix_;
        };

        class OutputHandler
        {
        public:

            OutputHandler(void)
            {
            }

            virtual ~OutputHandler(void)
            {
            }

            virtual void error(const std::string &text) = 0;

            virtual void warn(const std::string &text) = 0;

            virtual void inform(const std::string &text) = 0;

            virtual void debug(const std::string &text) = 0;
        };

        class OutputHandlerSTD : public OutputHandler
        {
        public:

            OutputHandlerSTD(void) : OutputHandler()
            {
            }

            virtual void error(const std::string &text);

            virtual void warn(const std::string &text);

            virtual void inform(const std::string &text);

            virtual void debug(const std::string &text);


        };

        void noOutputHandler(void);

        void restorePreviousOutputHandler(void);

        void useOutputHandler(OutputHandler *oh);

        OutputHandler* getOutputHandler(void);
    }

}

#endif

---

ompl
Author(s): Ioan Sucan/isucan@rice.edu, Mark Moll/mmoll@rice.edu, Lydia Kavraki/kavraki@rice.edu
autogenerated on Fri Jan 11 09:33:19 2013