OpenWalnut  1.4.0
WGERequirement.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 WGEREQUIREMENT_H
00026 #define WGEREQUIREMENT_H
00027 
00028 #include <string>
00029 
00030 #include "../common/WRequirement.h"
00031 
00032 
00033 /**
00034  * This requirement ensures an up and running WGE.
00035  */
00036 class WGERequirement: public WRequirement // NOLINT
00037 {
00038 public:
00039     /**
00040      * Create instance. If your module uses this requirement, it needs running WGE.
00041      */
00042     WGERequirement();
00043 
00044     /**
00045      * Destructor.
00046      */
00047     virtual ~WGERequirement();
00048 
00049     /**
00050      * Checks if the requirement is fulfilled on the system. Implement this for your specific case.
00051      *
00052      * \return true if the specific requirement is fulfilled.
00053      */
00054     virtual bool isComplied() const;
00055 
00056     /**
00057      * Return a nice description of the requirement.
00058      *
00059      * \return the description.
00060      */
00061     virtual std::string getDescription() const;
00062 
00063 protected:
00064 private:
00065 };
00066 
00067 #endif  // WGEREQUIREMENT_H
00068