RVLAlg::StateAlg< T > Class Template Reference

A StateAlg is an algorithm with the addition of an explicit state variable. More...

#include <alg.hh>

Inheritance diagram for RVLAlg::StateAlg< T >:

RVLAlg::Algorithm List of all members.

Public Member Functions

virtual T & getState ()=0
virtual const T & getState () const =0

Detailed Description

template<class T>
class RVLAlg::StateAlg< T >

A StateAlg is an algorithm with the addition of an explicit state variable.

The StateAlg must know how to set its state to a specified value and be able to return a reference to its state when requested. We do not require it to own a copy of the state at all times, as this may be expensive and the state can be assembled from other data when necessary. However, we expect that most StateAlgs will own a private data member which is the state.

Definition at line 241 of file alg.hh.


Member Function Documentation

template<class T>
virtual T& RVLAlg::StateAlg< T >::getState (  )  [pure virtual]

template<class T>
virtual const T& RVLAlg::StateAlg< T >::getState (  )  const [pure virtual]


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