networkManagerInterface.h

Go to the documentation of this file.

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

#pragma once

#include "vrfMsgTransport/vrfMsgTransportDefines.h"
#include <vrfStateData/stateDataTypes.h>
#include <matrix/vlVector.h>
#include <vrfutil/uuid.h>
#include <set>
#include <memory>

class DtOutputStream;
class DtEntityType;
class DtNetworkInterfaceManager;
class DtCommunicationManager;
class DtVrfParameterDb;
class DtScenario;
class Coordinate_System;
class DtEntityType;
class DtEntityIdentifier;
struct DtCommunicationManagerPerformanceTimerInformation;

namespace makVrf
{
   class DtStateData;
}

namespace makVrfEvents
{
   class DtEvent;
   class DtEventManager;
}

class DtUUID;

class DT_DLL_vrfMsgTransport DtNetworkManagerInterface
{
public:

   enum AddEventResult
   {
      DoNotContinue = 0,
      Continue = 0x00000001,
   };

   DtNetworkManagerInterface()
   {
   }

   virtual ~DtNetworkManagerInterface()
   {
   }

   virtual bool waitingToAddObjects() const = 0;

   virtual void beginFrame(double simTime) = 0;

   virtual bool preAdvanceFrame() = 0;

   virtual void advanceFrame(double* networkFrameTime = nullptr) = 0;

   virtual const char* type() const = 0;

   virtual bool stateDataAdded(makVrf::DtStateData*) = 0;

   virtual void stateDataAboutToBeRemoved(const makVrf::DtStateData*) = 0;

   virtual bool printDataToStream(const DtUUID&, DtOutputStream&) const = 0;

   virtual void setInterest(const DtVector& geocentricCenter, double radius) = 0;

   virtual bool init(DtCommunicationManager*) = 0;

   virtual void reserve(unsigned numToReserve) = 0;

   virtual void setNumCallbackThreads(unsigned) = 0;

   virtual bool supportsOwnershipTransfer() const = 0;

   virtual void setEnabled(bool) = 0;

   virtual DtString nextEventId(const DtString& = DtString::nullString()) = 0;

   virtual std::string protocol() const = 0;

   virtual void setRunFullyThreaded(bool) = 0;

   virtual void printReflectedObjectCounts() const = 0;

   virtual void requestUpdatesForRemoteNonVrfObjects() const = 0;

   virtual const makVrf::DtStateData* stateDataForGlobalId(const DtString&) const = 0;

   virtual void setCoordinateSystem(const Coordinate_System*) = 0;

   virtual void setParameterDatabase(DtVrfParameterDb*) = 0;

   virtual unsigned int maxNameLengthForType(const DtEntityType&) const = 0;

   virtual void setVrfSessionId(int) = 0;

   virtual void setVrfMessageVersionSupported(int) = 0;

   virtual void startScenarioLoad(bool) = 0;

   virtual void endScenarioLoad(bool) = 0;

   virtual void setSiteAppId(int, int) = 0;

   virtual AddEventResult addEvent(const makVrfEvents::DtEvent&, bool& selfReflected) = 0;

   virtual AddEventResult sendEvent(const makVrfEvents::DtEvent&) = 0;

   virtual void setEventManager(makVrfEvents::DtEventManager*) = 0;

   virtual DtU32 scenarioCapabilities() const = 0;
   virtual void setScenarioCapabilities(DtU32) = 0;

   virtual void resetSimulation() = 0;

   virtual void setFrameRateMode(const DtString& mode, double deltaTime, bool manageTime = false) = 0;

   virtual void rewindScenario() = 0;

   virtual void run() = 0;

   virtual void pause() = 0;

   virtual bool typeIsPublishable(const DtEntityType&) const = 0;

   virtual void setSimTime(double) = 0;

   virtual void setTimeMultiplier(double) = 0;

   virtual void setExerciseStartTime(double) = 0;

   virtual bool validateScenario(const DtScenario&, DtString& error) const = 0;

   virtual double determineSimTime(double& dt, DtCommunicationManagerPerformanceTimerInformation* performanceTimerInformation = nullptr) { return 0; };

   virtual bool hasSimulationTime() const = 0;

   virtual void removeAndDeleteAll(const std::set<DtUUID>& except = std::set<DtUUID>()) = 0;

   virtual bool needsUnpublishedDatabase() const = 0;

   virtual bool selfReflecting() const = 0;
   
   virtual void setSelfReflecting(bool) = 0;

   virtual bool rediscoverObjects() = 0;

   virtual bool publishingOnLegionNetwork() const = 0;

   virtual void reserveEntityId(const DtEntityIdentifier&) = 0;

   virtual void beginBulkCreate() {}
   virtual void endBulkCreate() {}

   virtual bool hasNetworkRepresentation(const DtUUID&) const = 0;
};