Stringable.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID 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 3 of the License, or
(at your option) any later version.

MeRMaID 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 MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename Stringable.hpp
 * @Description Stringable class definition.
 * @Status Implementing
 * @Version $Id: Stringable.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa + Nelson Ramos
 */

#ifndef __SYNTACTICSUGAR_STRINGABLE_H_
#define __SYNTACTICSUGAR_STRINGABLE_H_

#include <string>


namespace mermaid
{
  namespace support
  {
    namespace syntacticsugar
    {
      /**
      * @Class Stringable Stringable.hpp "Stringable.hpp"
      * @Description This class is to be inherited by all classes
      * @Description which can be converted to string
      * @Author Marco Barbosa + Nelson Ramos
      */
      class Stringable
      {
        public:
        
          virtual ~Stringable() {};
          
          /**
          * @Description string cast operator
          */
          virtual operator std::string() const = 0;
      };
    } // namespace syntacticsugar
  } // namespace support
} // namespace mermaid

#endif // __SYNTACTICSUGAR_STRINGABLE_H_