Evoplex  0.2.1
Public Member Functions | List of all members
evoplex::AbstractGraphInterface Class Referenceabstract

Provides a common interface for Graph plugins. More...

#include <abstractgraph.h>

Inheritance diagram for evoplex::AbstractGraphInterface:
evoplex::AbstractPlugin evoplex::AbstractGraph

Public Member Functions

virtual ~AbstractGraphInterface ()=default
 Provide a default destructor to keep compilers happy.
 
virtual bool reset ()=0
 Resets the graph object to the original state. More...
 
virtual bool init ()
 Initializes the plugin. More...
 
- Public Member Functions inherited from evoplex::AbstractPlugin
virtual bool init ()
 Initializes the plugin. More...
 
PRGprg () const
 pseudo-random generator pointer. More...
 
PRGrand () const
 prg() alias More...
 
const Attributesattrs () const
 Gets the plugin's attributes.
 
const QString & attrName (int attrId) const
 Gets the attribute's name for attrId. More...
 
const Valueattr (int attrId) const
 Gets the attribute's value for attrId. More...
 
Value attr (const QString &name, Value defaultValue=Value()) const
 Gets the value of the attribute name. More...
 
bool attrExists (const char *name) const
 Checks if the plugin's attribute name exists. More...
 
bool attrExists (const QString &name) const
 Checks if the plugin's attribute name exists. More...
 

Additional Inherited Members

- Protected Member Functions inherited from evoplex::AbstractPlugin
 AbstractPlugin ()=default
 constructor
 
 ~AbstractPlugin ()=default
 destructor
 
- Protected Attributes inherited from evoplex::AbstractPlugin
Trial * m_trial
 

Detailed Description

Provides a common interface for Graph plugins.

See also
AbstractGraph

Member Function Documentation

◆ init()

virtual bool evoplex::AbstractPlugin::init

Initializes the plugin.

This method is called when the plugin is created and is mainly used to validate inputs and set the environment. The default implementation does nothing.

Returns
true if successful

◆ reset()

virtual bool evoplex::AbstractGraphInterface::reset ( )
pure virtual

Resets the graph object to the original state.

This method is triggered after a successful AbstractPlugin::init().

Returns
true if successful.

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