Command.h

Go to the documentation of this file.

#ifndef _COMMAND_HEADER
#define _COMMAND_HEADER


#include "TtsString.h"


namespace ot
{


const std::string voiceCmds[] =
{
        "listen", "quit", "exit", "stop", "again", "go on", "undo", "redo", "reset", 
        "up", "move up", "continuously up", "continuously move up", 
        "down", "move down", "continuously down", "continuously move down", 
        "right", "move right", "continuously right", "continuously move right", 
        "left", "move left", "continuously left", "continuously move left", 
        "forward", "move forward", "continuously forward", "continuously move forward", 
        "backward", "move backward", "continuously backward", "continuously move backward", 
        "axial", "sagittal", "coronal", 
        "rotate right", "rotate right fast", "continuously rotate right", "continuously rotate right fast", 
        "rotate left", "rotate left fast", "continuously rotate left", "continuously rotate left fast", 
        "roll clockwise", "roll clockwise fast", "continuously roll clockwise", "continuously roll clockwise fast", 
        "roll counterclockwise", "roll counterclockwise fast", "continuously roll counterclockwise", "continuously roll counterclockwise fast", 
        "tilt up", "tilt up fast", "continuously tilt up", "continuously tilt up fast", 
        "tilt down", "tilt down fast", "continuously tilt down", "continuously tilt down fast", 
        "save one", "save two", "save three", "save four", "save five", 
        "restore one", "restore two", "restore three", "restore four", "restore five", 
        "scale up", "scale down"
};


class SpeechControlSource;
class Event;
class CommandStack;


// class *Command*
// *******************************************************************************************
// - should not be instantiated (could not be abstract because CommandStack is a std::list)
// - base class for commands, implementing the command pattern for undo/redo functionality

class Command
{
public:
        Command(TtsString &name_, TtsString &cmdclass_, SpeechControlSource &parentSrc_, bool undoable_ = false, bool extendable_ = false);

        virtual bool                    redo()                                          { return false; };
        virtual bool                    undo()                                          { return false; };
        virtual bool                    combine(Command &cmd)           { return false; };
        virtual bool                    extend()                                        { return false; };
        bool                                    isCombinable(Command &cmd)      { return extendable && (cmdclass.str == cmd.cmdclass.str); };
        bool                                    isExtendable()                          { return extendable; };
        bool                                    isUndoable()                            { return undoable; };
        TtsString&                              getName()                                       { return name; };
        TtsString&                              getCmdClass()                           { return cmdclass; };
        TtsString&                              getFailureMsg()                         { return failureMsg; };
        TtsString&                              getSuccessMsg()                         { return successMsg; };
        static Command*                 createCommand(std::string cmdName, SpeechControlSource &parentSrc);

protected:
        void                                    setEvent(Event &newEvent);
        Event&                                  getEvent();
        Command*                                getLastCmd();
        Command*                                getUndoCmd();
        Command*                                getRedoCmd();
        
        SpeechControlSource&    parentSrc;
        TtsString                               name;
        TtsString                               cmdclass;
        TtsString                               failureMsg;
        TtsString                               successMsg;
        bool                                    extendable;
        bool                                    undoable;
        static double                   scale;
};


} // namespace ot


#endif

---