Class MinimumEnergy

Defined in File BreakCondition.h

Inheritance Relationships

Base Type

public AbstractCondition (Class AbstractCondition)

Class Documentation

class MinimumEnergy : public AbstractCondition 

Deactivates the candidate below a minimum energy.

This module deactivates the candidate below a given minimum energy. In that case the property (“Deactivated”, module::description) is set.

Public Functions

MinimumEnergy(double minEnergy = 0)

void setMinimumEnergy(double energy)

double getMinimumEnergy() const

virtual std::string getDescription() const

virtual void process(Candidate *candidate) const

void onReject(Module *rejectAction)

void onAccept(Module *acceptAction)

void setMakeRejectedInactive(bool makeInactive)

void setMakeAcceptedInactive(bool makeInactive)

void setRejectFlag(std::string key, std::string value)

void setAcceptFlag(std::string key, std::string value)

void setDescription(const std::string &description)

inline void process(ref_ptr<Candidate> candidate) const

inline size_t addReference() const

inline size_t removeReference() const

inline int removeReferenceNoDelete() const

inline size_t getReferenceCount() const

Protected Functions

void reject(Candidate *candidate) const

inline void reject(ref_ptr<Candidate> candidate) const

void accept(Candidate *candidate) const

inline void accept(ref_ptr<Candidate> candidate) const

Protected Attributes

ref_ptr<Module> rejectAction

ref_ptr<Module> acceptAction

bool makeRejectedInactive

bool makeAcceptedInactive

std::string rejectFlagKey

std::string rejectFlagValue

std::string acceptFlagKey

std::string acceptFlagValue

mutable size_t _referenceCount