Action.h

Go to the documentation of this file.

#ifndef OPAL_Action_HH
#define OPAL_Action_HH

// ------------------------------------------------------------------------
// $RCSfile: Action.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Action
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:34 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------

#include "AbstractObjects/Object.h"


// Class Action
// ------------------------------------------------------------------------
//  It implements the common behavior of actions, it can also be used via
//  dynamic casting to determine whether an object represents an action.

class Action: public Object {

public:

    virtual ~Action();

    //  Always return [b]true[/b].
    virtual bool canReplaceBy(Object *object);

    //  Return the string "ACTION".
    virtual const std::string getCategory() const;

    //  If true, the object's execute() function should be traced.
    //  Always true for actions.
    virtual bool shouldTrace() const;

    //  If true, the data structure should be updated before calling execute().
    //  Always true for actions.
    virtual bool shouldUpdate() const;

protected:

    Action(int size, const char *name, const char *help);

    Action(const std::string &name, Action *parent);

private:

    // Not implemented.
    Action();
    Action(const Action &);
    void operator=(const Action &);
};

#endif // OPAL_Action_HH