OpenWalnut 1.2.5
|
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 WREQUIREMENT_H 00026 #define WREQUIREMENT_H 00027 00028 #include <string> 00029 00030 #include "WExportCommon.h" 00031 00032 /** 00033 * Base class for all possible kinds of requirements. Derive your own kind of requirement from this class. This allows easy checking of required 00034 * features on a target system. Of course this is only useful for things checkable during runtime. You should avoid writing classes for checking 00035 * weather some library is installed or not. This is checked by the linker on the target system. 00036 */ 00037 class OWCOMMON_EXPORT WRequirement // NOLINT 00038 { 00039 public: 00040 00041 /** 00042 * Default constructor. 00043 */ 00044 WRequirement(); 00045 00046 /** 00047 * Destructor. 00048 */ 00049 virtual ~WRequirement(); 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 = 0; 00057 00058 /** 00059 * Return a nice description of the requirement. 00060 * 00061 * \return the description. 00062 */ 00063 virtual std::string getDescription() const = 0; 00064 00065 protected: 00066 00067 private: 00068 }; 00069 00070 #endif // WREQUIREMENT_H 00071