OpenWalnut  1.5.0dev
Public Member Functions | List of all members
WRequirement Class Referenceabstract

Base class for all possible kinds of requirements. More...

#include <WRequirement.h>

+ Inheritance diagram for WRequirement:

Public Member Functions

 WRequirement ()
 Default constructor. More...
 
virtual ~WRequirement ()
 Destructor. More...
 
virtual bool isComplied () const =0
 Checks if the requirement is fulfilled on the system. More...
 
virtual std::string getDescription () const =0
 Return a nice description of the requirement. More...
 

Detailed Description

Base class for all possible kinds of requirements.

Derive your own kind of requirement from this class. This allows easy checking of required features on a target system. Of course this is only useful for things checkable during runtime. You should avoid writing classes for checking weather some library is installed or not. This is checked by the linker on the target system.

Definition at line 37 of file WRequirement.h.

Constructor & Destructor Documentation

◆ WRequirement()

WRequirement::WRequirement ( )

Default constructor.

Definition at line 27 of file WRequirement.cpp.

◆ ~WRequirement()

WRequirement::~WRequirement ( )
virtual

Destructor.

Definition at line 32 of file WRequirement.cpp.

Member Function Documentation

◆ getDescription()

virtual std::string WRequirement::getDescription ( ) const
pure virtual

Return a nice description of the requirement.

Returns
the description.

Implemented in WUIRequirement, WPrototypeRequirement, and WGERequirement.

◆ isComplied()

virtual bool WRequirement::isComplied ( ) const
pure virtual

Checks if the requirement is fulfilled on the system.

Implement this for your specific case.

Returns
true if the specific requirement is fulfilled.

Implemented in WUIRequirement, WPrototypeRequirement, and WGERequirement.


The documentation for this class was generated from the following files: