OpenWalnut  1.4.0
WPrototyped.h
00001 //---------------------------------------------------------------------------
00002 //
00003 // Project: OpenWalnut ( http://www.openwalnut.org )
00004 //
00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
00006 // For more information see http://www.openwalnut.org/copying
00007 //
00008 // This file is part of OpenWalnut.
00009 //
00010 // OpenWalnut is free software: you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as published by
00012 // the Free Software Foundation, either version 3 of the License, or
00013 // (at your option) any later version.
00014 //
00015 // OpenWalnut is distributed in the hope that it will be useful,
00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00018 // GNU Lesser General Public License for more details.
00019 //
00020 // You should have received a copy of the GNU Lesser General Public License
00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
00022 //
00023 //---------------------------------------------------------------------------
00024 
00025 #ifndef WPROTOTYPED_H
00026 #define WPROTOTYPED_H
00027 
00028 #include <string>
00029 
00030 #include <boost/shared_ptr.hpp>
00031 
00032 
00033 
00034 /**
00035  * Interface class for the concept "Prototype". The requirements are a zero-parameter constructor.
00036  */
00037 class WPrototyped // NOLINT
00038 {
00039 public:
00040     /**
00041      * Default constructor. Creates a instance of the class. This not necessarily mean that the instance is fully usable. This is
00042      * required for type checking and inheritance checking.
00043      */
00044     WPrototyped();
00045 
00046     /**
00047      * Destructor.
00048      */
00049     virtual ~WPrototyped();
00050 
00051     /**
00052      * Gets the name of this prototype.
00053      *
00054      * \return the name.
00055      */
00056     virtual const std::string getName() const = 0;
00057 
00058     /**
00059      * Gets the description for this prototype.
00060      *
00061      * \return the description
00062      */
00063     virtual const std::string getDescription() const = 0;
00064 
00065     /**
00066      * Checks whether the actual prototype has the specified runtime type.
00067      *
00068      * \return true if you can safely cast this instance to the specified type.
00069      */
00070     template < typename T > bool isA();
00071 
00072 protected:
00073 private:
00074 };
00075 
00076 template < typename T >
00077 bool WPrototyped::isA()
00078 {
00079     return dynamic_cast< T* >( this );
00080 }
00081 
00082 #endif  // WPROTOTYPED_H
00083