OpenWalnut
1.4.0
|
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 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 WPrototypeRequirement: public WRequirement // NOLINT 00037 { 00038 public: 00039 /** 00040 * Create instance. If your module uses this requirement, it needs the specified module. 00041 * 00042 * \param prototype the module needed. 00043 */ 00044 explicit WPrototypeRequirement( std::string prototype ); 00045 00046 /** 00047 * Destructor. 00048 */ 00049 virtual ~WPrototypeRequirement(); 00050 00051 /** 00052 * Checks if the requirement is fulfilled on the system. Implement this for your specific case. 00053 * 00054 * \return true if the specific requirement is fulfilled. 00055 */ 00056 virtual bool isComplied() const; 00057 00058 /** 00059 * Return a nice description of the requirement. 00060 * 00061 * \return the description. 00062 */ 00063 virtual std::string getDescription() const; 00064 00065 protected: 00066 private: 00067 /** 00068 * The required prototype. 00069 */ 00070 std::string m_prototype; 00071 }; 00072 00073 #endif // WPROTOTYPEREQUIREMENT_H 00074