OpenWalnut
1.4.0
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
src
core
graphicsEngine
WGERequirement.h
1
//---------------------------------------------------------------------------
2
//
3
// Project: OpenWalnut ( http://www.openwalnut.org )
4
//
5
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6
// For more information see http://www.openwalnut.org/copying
7
//
8
// This file is part of OpenWalnut.
9
//
10
// OpenWalnut is free software: you can redistribute it and/or modify
11
// it under the terms of the GNU Lesser General Public License as published by
12
// the Free Software Foundation, either version 3 of the License, or
13
// (at your option) any later version.
14
//
15
// OpenWalnut is distributed in the hope that it will be useful,
16
// but WITHOUT ANY WARRANTY; without even the implied warranty of
17
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
// GNU Lesser General Public License for more details.
19
//
20
// You should have received a copy of the GNU Lesser General Public License
21
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22
//
23
//---------------------------------------------------------------------------
24
25
#ifndef WGEREQUIREMENT_H
26
#define WGEREQUIREMENT_H
27
28
#include <string>
29
30
#include "../common/WRequirement.h"
31
32
33
/**
34
* This requirement ensures an up and running WGE.
35
*/
36
class
WGERequirement
:
public
WRequirement
// NOLINT
37
{
38
public
:
39
/**
40
* Create instance. If your module uses this requirement, it needs running WGE.
41
*/
42
WGERequirement
();
43
44
/**
45
* Destructor.
46
*/
47
virtual
~WGERequirement
();
48
49
/**
50
* Checks if the requirement is fulfilled on the system. Implement this for your specific case.
51
*
52
* \return true if the specific requirement is fulfilled.
53
*/
54
virtual
bool
isComplied
()
const
;
55
56
/**
57
* Return a nice description of the requirement.
58
*
59
* \return the description.
60
*/
61
virtual
std::string
getDescription
()
const
;
62
63
protected
:
64
private
:
65
};
66
67
#endif // WGEREQUIREMENT_H
68
Generated by
1.8.4