remoteControlCommands.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2018 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

//\file remoteControlCommands.h

#pragma once

#include <vrvUtil/signalslib.h>
#include <vlpi/entityType.h>

#include <QtCore/QStringList>

namespace makVrv
{
   class DtDe;
}

class QString;
class DtEntityIdentifier;
class DtObjectType;
class DtUUID;

//These classes will represent commands that can be executed by using the
//DtVrossThreadVrfRemoteControl class.

class DtRemoteControlCommand
{
public:
   virtual bool execute(makVrv::DtDe&, const QString& command) = 0;
   virtual DtRemoteControlCommand* clone() const = 0;

   QString help() const
   {
      return myHelp;
   }

   QString command() const
   {
      return myCommand;
   }

   boost::signal<void (const QString&, DtRemoteControlCommand*)> signal_commandComplete;

protected:
   //Parse out the string.  All tokens are separated by spaces or enclosed in quotes or
   //parens
   virtual QStringList tokenize(const QString&, char delim = ' ') const;

   //Parses a point of the form x,y,z
   bool parsePoint(const QString&, DtVector&) const;

protected:
   DtRemoteControlCommand(const QString& command, const QString& help);
   DtRemoteControlCommand(const DtRemoteControlCommand&);

protected:
   QString myCommand;
   QString myHelp;
};

//This command will create a single point object (entity, waypoint, aggregate) and will notify the user
//when the command has been completed
class DtRemoteControlCreateCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlCreateCommand();

   virtual ~DtRemoteControlCreateCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;

   //Convert string to entity type either by name or by actual type
   DtEntityType entityToCreate(const QString& c, makVrv::DtDe& de) const;

   //Returns the currently selected simulation address
   DtSimulationAddress simulationAddress(makVrv::DtDe&) const;

protected:
   //Called when the object is created, will signal complete with the name and the object id
   void objectCreated(DtString, const DtUUID&, const DtEntityIdentifier&, const DtObjectType&);
};

//Closes the current scenario

class DtRemoteControlCloseScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlCloseScenarioCommand();
   virtual ~DtRemoteControlCloseScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Loads the specified scenario into the simulation

class DtRemoteControlLoadScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlLoadScenarioCommand();
   virtual ~DtRemoteControlLoadScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Loads a new scenario into the system

class DtRemoteControlNewScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlNewScenarioCommand();
   virtual ~DtRemoteControlNewScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Rewinds the current scenario

class DtRemoteControlRewindScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlRewindScenarioCommand();
   virtual ~DtRemoteControlRewindScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Pauses the current scenario

class DtRemoteControlPauseScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlPauseScenarioCommand();
   virtual ~DtRemoteControlPauseScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Plays the current scenario

class DtRemoteControlPlayScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlPlayScenarioCommand();
   virtual ~DtRemoteControlPlayScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};

//Saves the current scenario

class DtRemoteControlSaveScenarioCommand : public DtRemoteControlCommand
{
public:
   DtRemoteControlSaveScenarioCommand();
   virtual ~DtRemoteControlSaveScenarioCommand();

   virtual bool execute(makVrv::DtDe&, const QString& command);
   virtual DtRemoteControlCommand* clone() const;
};