OpenWalnut  1.4.0
Public Member Functions | Private Attributes
WPrototypeRequirement Class Reference

This requirement ensures that the specified prototype exists in the factory. More...

#include <WPrototypeRequirement.h>

+ Inheritance diagram for WPrototypeRequirement:

List of all members.

Public Member Functions

 WPrototypeRequirement (std::string prototype)
 Create instance.
virtual ~WPrototypeRequirement ()
 Destructor.
virtual bool isComplied () const
 Checks if the requirement is fulfilled on the system.
virtual std::string getDescription () const
 Return a nice description of the requirement.

Private Attributes

std::string m_prototype
 The required prototype.

Detailed Description

This requirement ensures that the specified prototype exists in the factory.

These requirements are especially useful for container modules.

Definition at line 36 of file WPrototypeRequirement.h.


Constructor & Destructor Documentation

WPrototypeRequirement::WPrototypeRequirement ( std::string  prototype) [explicit]

Create instance.

If your module uses this requirement, it needs the specified module.

Parameters:
prototypethe module needed.

Definition at line 31 of file WPrototypeRequirement.cpp.

Destructor.

Definition at line 38 of file WPrototypeRequirement.cpp.


Member Function Documentation

std::string WPrototypeRequirement::getDescription ( ) const [virtual]

Return a nice description of the requirement.

Returns:
the description.

Implements WRequirement.

Definition at line 48 of file WPrototypeRequirement.cpp.

References m_prototype.

bool WPrototypeRequirement::isComplied ( ) const [virtual]

Checks if the requirement is fulfilled on the system.

Implement this for your specific case.

Returns:
true if the specific requirement is fulfilled.

Implements WRequirement.

Definition at line 43 of file WPrototypeRequirement.cpp.

References WModuleFactory::getModuleFactory(), and m_prototype.


Member Data Documentation

std::string WPrototypeRequirement::m_prototype [private]

The required prototype.

Definition at line 70 of file WPrototypeRequirement.h.

Referenced by getDescription(), and isComplied().


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