RVLAlg::Algorithm Class Reference

Algorithm is the abstract base class for the algorithm package. More...

#include <alg.hh>

Inheritance diagram for RVLAlg::Algorithm:

RVLAlg::BranchAlg RVLAlg::ListAlg RVLAlg::LoopAlg RVLAlg::NoAlg RVLAlg::StateAlg< T > RVLAlg::CondListAlg RVLAlg::DoLoopAlg List of all members.

Public Member Functions

 Algorithm ()
virtual ~Algorithm ()
virtual void run ()=0
 This is the only required member function.

Detailed Description

Algorithm is the abstract base class for the algorithm package.

An Algorithm is something you can run(). We intentionally do not restrict the behavior any further. This allows implementors to write a variety of constructors and access methods. We recommend that Algorithms own very little internal data; This should mostly be intermediate calculations that are stored to avoid unnecessary calculations. Constructors will often take references to external objects, and the algorithm object will then store this reference so that it can operate on these objects when told to run().

Definition at line 67 of file alg.hh.


Constructor & Destructor Documentation

RVLAlg::Algorithm::Algorithm (  ) 

Definition at line 70 of file alg.hh.

virtual RVLAlg::Algorithm::~Algorithm (  )  [virtual]

Definition at line 71 of file alg.hh.


Member Function Documentation

virtual void RVLAlg::Algorithm::run (  )  [pure virtual]

This is the only required member function.

When called the object should execute its expected behavior.

Implemented in RVLAlg::NoAlg, RVLAlg::ListAlg, RVLAlg::LoopAlg, RVLAlg::DoLoopAlg, RVLAlg::CondListAlg, and RVLAlg::BranchAlg.

Referenced by RVLAlg::BranchAlg::run(), RVLAlg::CondListAlg::run(), RVLAlg::DoLoopAlg::run(), RVLAlg::LoopAlg::run(), and RVLAlg::ListAlg::run().


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for RvlAlg by  doxygen 1.4.7