Printable.h

00001 /*
00002   Printable.h - Interface class that allows printing of complex types
00003   Copyright (c) 2011 Adrian McEwen.  All right reserved.
00004 
00005   This library is free software; you can redistribute it and/or
00006   modify it under the terms of the GNU Lesser General Public
00007   License as published by the Free Software Foundation; either
00008   version 2.1 of the License, or (at your option) any later version.
00009 
00010   This library is distributed in the hope that it will be useful,
00011   but WITHOUT ANY WARRANTY; without even the implied warranty of
00012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013   Lesser General Public License for more details.
00014 
00015   You should have received a copy of the GNU Lesser General Public
00016   License along with this library; if not, write to the Free Software
00017   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00018 */
00019 
00020 #ifndef Printable_h
00021 #define Printable_h
00022 
00023 //#include <new.h> // jonne - only needed by avr-gcc
00024 
00025 class Print;
00026 
00027 /** The Printable class provides a way for new classes to allow themselves to be printed.
00028     By deriving from Printable and implementing the printTo method, it will then be possible
00029     for users to print out instances of this class by passing them into the usual
00030     Print::print and Print::println methods.
00031 */
00032 
00033 class Printable
00034 {
00035   public:
00036     virtual size_t printTo(Print& p) const = 0;
00037 };
00038 
00039 #endif
00040