OpenWalnut 1.2.5

WPrototypeRequirement.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 WPROTOTYPEREQUIREMENT_H
00026 #define WPROTOTYPEREQUIREMENT_H
00027 
00028 #include <string>
00029 
00030 #include "../common/WRequirement.h"
00031 #include "WExportKernel.h"
00032 
00033 /**
00034  * This requirement ensures that the specified prototype exists in the factory. These requirements are especially useful for container modules.
00035  */
00036 class OWKERNEL_EXPORT WPrototypeRequirement: public WRequirement // NOLINT
00037 {
00038 public:
00039 
00040     /**
00041      * Create instance. If your module uses this requirement, it needs the specified module.
00042      *
00043      * \param prototype the module needed.
00044      */
00045     explicit WPrototypeRequirement( std::string prototype );
00046 
00047     /**
00048      * Destructor.
00049      */
00050     virtual ~WPrototypeRequirement();
00051 
00052     /**
00053      * Checks if the requirement is fulfilled on the system. Implement this for your specific case.
00054      *
00055      * \return true if the specific requirement is fulfilled.
00056      */
00057     virtual bool isComplied() const;
00058 
00059     /**
00060      * Return a nice description of the requirement.
00061      *
00062      * \return the description.
00063      */
00064     virtual std::string getDescription() const;
00065 
00066 protected:
00067 
00068 private:
00069 
00070     /**
00071      * The required prototype.
00072      */
00073     std::string m_prototype;
00074 };
00075 
00076 #endif  // WPROTOTYPEREQUIREMENT_H
00077 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends