jaus++/2.0/include/jaus/mobility/drivers/listdriver.h

Go to the documentation of this file.

#ifndef __JAUS_MOBILITY_LIST_DRIVER__H
#define __JAUS_MOBILITY_LIST_DRIVER__H

#include "jaus/mobility/list/listmanager.h"
#include "jaus/mobility/drivers/settravelspeed.h"
#include "jaus/mobility/drivers/querytravelspeed.h"
#include "jaus/mobility/drivers/reporttravelspeed.h"

namespace JAUS
{
    class JAUS_MOBILITY_DLL ListDriver : public ListManager::Child
    {
    public:
        ListDriver(const ID& serviceIdentifier,
                   const ID& parentServiceIdentifier);
        virtual ~ListDriver();
        // Method called when transitioning to a ready state.
        virtual bool Resume() { return true; }
        // Method called to transition due to reset.
        virtual bool Reset() { return true; }
        // Method called when transitioning to a standby state.
        virtual bool Standby() { return true; }
        // Method called to modify travel speed.
        virtual void SetExecutionSpeed(const double speedMetersPerSecond);
        // Method called to begin/continue execution of a list.
        virtual void ExecuteList(const double speedMetersPerSecond) = 0;
        // Method to check if we should be executing the list because we received a command.
        virtual bool IsExecuting() const;
        // Service is always discoverable.
        virtual bool IsDiscoverable() const { return true; }
        // Method called whenever a message is received.
        virtual void Receive(const Message* message);
        // Creates messages associated with this service.
        virtual Message* CreateMessage(const UShort messageCode) const;
        // Gets the speed to execute at.
        inline double GetExecutionSpeed() const { Mutex::ScopedLock lock(&mListDriverMutex); return mSpeedMetersPerSecond; }
    protected:
        Mutex mListDriverMutex;                 
        double mSpeedMetersPerSecond;           
    };
}

#endif
/*  End of File */