html/_operator_8h_source.html

#ifndef Operator_h

#define Operator_h


class Operator

{

public:

    virtual bool operate(StateP) = 0;


    virtual bool initialize(StateP)

    {   return true;    }


    virtual void registerParameters(StateP)

    {   }


    virtual void write(XMLNode&)

    {   }


    virtual void read(XMLNode&)

    {   }


    virtual ~Operator()

    {   }

};

typedef boost::shared_ptr<Operator> OperatorP;


#endif // Operator_h

Operator
Abstract operator class.
Definition: Operator.h:11

Operator::registerParameters
virtual void registerParameters(StateP)
Register parameters with the Registry. Called before Operator::initialize.
Definition: Operator.h:27

Operator::read
virtual void read(XMLNode &)
Read operator state from XMLNode or the Registry. Called after Operator::initialize.
Definition: Operator.h:41

Operator::operate
virtual bool operate(StateP)=0
perform the designated operation

Operator::write
virtual void write(XMLNode &)
Write operator state to XMLNode or the Registry. Called after Operator::initialize.
Definition: Operator.h:34

Operator::initialize
virtual bool initialize(StateP)
Perform initialization. Called before Operator::operate. By default, if the return value is false,...
Definition: Operator.h:20