textIf.h

Go to the documentation of this file.

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

#pragma once

#include <vlutil/vlUtil.h>
#include <vlpi/simulationAddress.h>

//This class provides a text interface for controlling VR-Forces's aerodrome stuff over the network.
//This interface currently supports the following actions:
//
//1. set [ lights | arrestorGear | runwayCondition ]
//     set a VR-Forces object attribute

//2. get [ lights | allLights | arrestorGear | allArrestorGear | runwayCondition  ]
//     get the corresponding value of a VR-Forces entity

//3. list [aerodromes | runways]
//     print the list of all aerodromes/runways in the simulation

//4. print [object]
//     print all relevant aerodrome information about a runway/aerodrome

//5. printAll
//     print all relevant aerodrome informations in the simulation

//6. quit
//     quit the application

class DtVrfRemoteController;
class DtSimMessage;
class DtReflectedControlObject;

class DtTextInterface
{
public:
  
  //constructor
  DtTextInterface(DtVrfRemoteController* controller/*, DtReflectedAerodromeObjectsManager* manager*/);

  //destructor
  virtual ~DtTextInterface();

  //Process entered text
  void readStdin();

  //Set/Get time to quit
  virtual void setTimeToQuit(bool yesNo);
  virtual bool timeToQuit() const;

  //Get remote vrf controller pointer
  virtual DtVrfRemoteController* controller() const;

  static void scenarioStatusCallback(DtSimMessage* msg, void* usr);

public:

  //Functions for parsing command strings
  virtual void setLights(char* str);
  virtual void setAllLights(char* str);
  virtual void setArrestorGear(char* str);
  virtual void setRunwayCondition(char* str);

  virtual void getLights(char* str);
  virtual void getAllLights(char* str);
  virtual void getArrestorGear(char* str);
  virtual void getAllArrestorGear(char* str);
  virtual void getRunwayCondition(char* str);

  virtual void listAerodromes();
  virtual void listRunways(char* str);

  virtual void printSpeciticObjectDatas(char* str);
  virtual void printAllDatas();

public:

   //-------------------------------------------------------
   //Text callback functions
   //-------------------------------------------------------

   //Called in response to "set"
   static void setCmd(char* s, DtTextInterface* a);

   //Called in response to "get"
   static void getCmd(char* s, DtTextInterface* a);

   //Called in response to "quit" or "q"
   static void quitCmd(char* s, DtTextInterface* a);

   //Called in response to "help" or "?" or "h"
   static void helpCmd(char* s, DtTextInterface* a);

   //Called in response to "list"
   static void listCmd(char* s, DtTextInterface* a);

   //Called in response to "print"
   static void printCmd(char* s, DtTextInterface* a);

   //Called in response to "printAll"
   static void printAllCmd(char* s, DtTextInterface* a);

public:

   //callback on the creation of control objects
   static void controlObjectAddedCallback(DtReflectedControlObject*, void* usr);
   virtual void processControlObjectAdded(DtReflectedControlObject*);

protected:

   //Present commmand line interface.
   void prompt();

   //Parse user input, call corresponding function
   void processCmd(char *buff);

protected :

   //method useful to look for a control object from its name
   //such methods already exists in the uuidNetworkManager(), but,in case if the entity has been renamed, it looks on all control objects in the simulation
   virtual DtReflectedControlObject* lookupVrfControlObjectByName(const std::string& markingText);

protected:

   bool myTimeToQuit;
   DtVrfRemoteController* myController;

private:
   int kbInterest;
};