vrfStatusPublisher.h

Go to the documentation of this file.

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


#pragma once

#include <vlutil/vlList.h>
#include <vlutil/vlTime.h>
#include <vl/hostStructs.h>
#include <vlutil/vlInetSocket.h>
#include <vlutil/vlInetAddr.h>
#include "vrfcgf/vrfcgfDefines.h"
#include <vrfmsgs/ifStatus.h>
#include <tbb/spin_mutex.h>

class DtSimMessage;
class DtSimulationAddress;
class DtVrfMessageInterface;
class DtIfStatus;
class DtLocalObjectManager;
class DtLocalObject;

class DT_DLL_vrfcgf DtVrfStatusPublisher
{
public:

   DtVrfStatusPublisher(DtVrfMessageInterface* messageIf, DtLocalObjectManager* mgr);

   virtual ~DtVrfStatusPublisher();

   virtual const DtSimulationAddress& address();
   virtual void setAddress(const DtSimulationAddress& address);

   virtual const DtTime& lastResponseTime();
   virtual void setLastResponseTime(const DtTime& time);

   virtual void setAlwaysSendStatusImmediately(bool);
   bool alwaysSendStatusImmediately() const
   {
      return myAlwaysSendStatusImmediately;
   }

   virtual void sendStatus(const DtSimulationAddress& address, bool sendImmediately = false);
   virtual void sendFinalStatus(bool sendImmediately = false);
   virtual void sendStatusToAll(bool sendImmediately = false);

   virtual void setHeartbeatInterval(int heartbeatInterval);
   virtual int heartbeatInterval();

   virtual DtInetAddr ipAddress() const;
   virtual void setIpAddress(const DtInetAddr& addr);

   virtual unsigned int port() const;
   virtual void setPort(unsigned int p);

   virtual int appIdRangeMax() const;
   virtual void setAppIdRangeMax(int p);

   virtual int controlState() const;
   virtual void setControlState(int state);

   virtual void clear();

   virtual void tick();

   virtual void processStatusRequestMessage(DtSimMessage * msg);

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

   virtual bool isLoaded() const;
   virtual void setIsLoaded(bool loaded);

   virtual void setScenarioRunId(int);
   virtual int scenarioRunId() const;

   virtual bool isActive() const;
   virtual void setIsActive(bool active);

   virtual bool canSimulate() const;
   virtual void setCanSimulate(bool canSimulate);

   virtual DtTime exerciseStartTime() const;
   virtual void setExerciseStartTime(DtTime time);

   virtual DtTime simTime() const;
   virtual void setSimTime(DtTime time);

   virtual DtTime runDurationTime() const;
   virtual void setRunDurationTime(DtTime);

   virtual DtTime simStartSimTime() const;
   virtual void setSimStartSimTime(DtTime time);
 
   virtual double timeMultiplier() const;
   virtual void setTimeMultiplier(double timeMultiplier);

   virtual void setLoadingScenario(bool);
   virtual bool loadingScenario() const;

   virtual void setSavingScenario(bool);
   virtual bool savingScenario() const;

   virtual void setImportingScenario(bool);
   virtual bool importingScenario() const;

   virtual void setReinitializingScenario(bool);
   virtual bool reinitializingScenario() const;

   virtual void setHostingDynamicTerrainServer(bool);
   virtual bool hostingDynamicTerrainServer() const;

   virtual void setCreatingSimulationObjectGroup(bool);
   virtual bool creatingSimulationObjectGroup() const;

   virtual void setClosingScenario(bool);
   virtual bool closingScenario() const;

   virtual void setRollingBackScenario(bool);
   virtual bool rollingBackScenario() const;

   virtual void setLoadedNewScenario(bool);
   virtual bool loadedNewScenario() const;

   //virtual bool isOldParameterDb() const;
   //virtual void setIsOldParameterDb(bool isOldParameterDb);

   virtual bool isCurrentParameterDb() const;
   virtual void setIsCurrentParameterDb(bool isCurrentParameterDb);

   virtual bool isResourceMonitorEnabled() const;
   virtual void setIsResourceMonitorEnabled(bool isEnabled);

   virtual void setIsTimeManaged(bool yesNo);
   virtual bool isTimeManaged() const;

   virtual void setSendStatusOnChange(bool);
   virtual bool sendStatusOnChange() const;

   virtual void addLocalObject(int kind, int domain);
   virtual void removeLocalObject(int kind, int domain);

   virtual DtU32 scenarioCapabilities() const;
   virtual void setScenarioCapabilities(DtU32 v);
   virtual void setScenarioCapability(DtU32 v, bool b);

   virtual DtString applicationType() const;
   virtual void setApplicationType(const DtString& type);

protected:
   static void simObjectAdded(const DtLocalObject*, void* usr);
   virtual void processSimObjectAdded(const DtLocalObject*);

   static void simObjectAboutToBeRemoved(const DtLocalObject*, void* usr);
   virtual void processSimObjectAboutToBeRemoved(const DtLocalObject*);

   static void simObjectConvertedToRemote(const DtLocalObject*, void* usr);
   virtual void processSimObjectConvertedToRemote(const DtLocalObject*);

protected:

   DtVrfStatusPublisher(const DtVrfStatusPublisher& orig);

   DtVrfStatusPublisher& operator=(const DtVrfStatusPublisher& orig);

protected:
   DtVrfMessageInterface* myMessageIf;
   int myHeartbeatInterval;   

   DtSimulationAddress  myAddress;
   bool                 myIsActive;
   bool                 myCanSimulate;
   DtTime               myLastResponseTime;
   bool                 myIsOldParameterDb;
   bool                 myHasBeenModified;
   bool                 mySendStatusOnChange;
   bool                 myLoadedNewScenario;
   bool                 myAlwaysSendStatusImmediately;
   DtLocalObjectManager*  myObjectManager;

   DtIfStatus* myStatus;
   tbb::spin_mutex myStatusMutex;
};