OpenWalnut 1.2.5

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 #include "WExportCommon.h"
00033 
00034 /**
00035  * Interface class for the concept "Prototype". The requirements are a zero-parameter constructor.
00036  */
00037 class OWCOMMON_EXPORT WPrototyped // NOLINT
00038 {
00039 public:
00040 
00041     /**
00042      * Default constructor. Creates a instance of the class. This not necessarily mean that the instance is fully usable. This is
00043      * required for type checking and inheritance checking.
00044      */
00045     WPrototyped();
00046 
00047     /**
00048      * Destructor.
00049      */
00050     virtual ~WPrototyped();
00051 
00052     /**
00053      * Gets the name of this prototype.
00054      *
00055      * \return the name.
00056      */
00057     virtual const std::string getName() const = 0;
00058 
00059     /**
00060      * Gets the description for this prototype.
00061      *
00062      * \return the description
00063      */
00064     virtual const std::string getDescription() const = 0;
00065 
00066     /**
00067      * Checks whether the actual prototype has the specified runtime type.
00068      *
00069      * \return true if you can safely cast this instance to the specified type.
00070      */
00071     template < typename T > bool isA();
00072 
00073 protected:
00074 private:
00075 };
00076 
00077 template < typename T >
00078 bool WPrototyped::isA()
00079 {
00080     return dynamic_cast< T* >( this );
00081 }
00082 
00083 #endif  // WPROTOTYPED_H
00084 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends