Class PerformanceModule

Defined in File Tools.h

Nested Relationships

Nested Types

Struct PerformanceModule::_module_info

Inheritance Relationships

Base Type

public Module (Class Module)

Class Documentation

class PerformanceModule : public Module 

Module to monitor the simulation performance.

Add modules under investigation to this module instead of the ModuleList.

Public Functions

~PerformanceModule()

void add(Module *module)

virtual void process(Candidate *candidate) const

Process function This is the main function to work with, it is called during every ModuleList::run step. Derived functions need to override this overload of process!

Parameters:: candidate – Candidate raw pointer

virtual std::string getDescription() const: Returns description, can be overriden by derived class.

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

Sets description, can be used instead of getDescription in derived class

Parameters:: description – Description string

inline void process(ref_ptr<Candidate> candidate) const: Process function Overload for process function to explicitly make a conversion from ref_ptr to a raw pointer

inline size_t addReference() const

inline size_t removeReference() const

inline int removeReferenceNoDelete() const

inline size_t getReferenceCount() const

Protected Attributes

mutable size_t _referenceCount