printable_object.hpp

Go to the documentation of this file.

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010 by Joel Andersson, Moritz Diehl, K.U.Leuven. All rights reserved.
 *
 *    CasADi 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.
 *
 *    CasADi 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 CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef PRINTABLE_OBJECT_HPP
#define PRINTABLE_OBJECT_HPP

#include <iostream>
#include <string>
#include <sstream>
#include <streambuf>
#include <vector>

namespace CasADi{

class PrintableObject{
  public:
    
#ifndef SWIG

    virtual void print(std::ostream &stream=std::cout) const;

    virtual void repr(std::ostream &stream=std::cout) const;

    friend std::ostream& operator<<(std::ostream &stream, const PrintableObject& obj);
#endif // SWIG  

    std::string getRepresentation() const;

    std::string getDescription() const;
  
};

#ifdef SWIG
%extend PrintableObject{
  std::string __str__()  { return $self->getDescription(); }
  std::string __repr__()  { return $self->getRepresentation(); }
}
#endif // SWIG    

} // namespace CasADi


#endif // PRINTABLE_OBJECT_HPP