simLocalEnvironmentalNetInterface.h

Go to the documentation of this file.

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





#pragma once

#include "vrfobjcore/simEnvironmentalNetInterface.h"
#include <vlutil/vlString.h>
#include <vlutil/vlList.h>
#include <vl/globalObjectDesignator.h>
#include <vrfExtObjects/simEnvironmentalModelType.h>

class DtVrfObject;
class DtVrfOverlayObjectStateRepository;
class DtEnvironmentProcessPublisher;
class DtEnvironmentProcessRepository;

class DtSimManager;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtSimLocalEnvironmentalNetInterface : 
   public DtSimEnvironmentalNetInterface
{
protected:
   DtSimLocalEnvironmentalNetInterface();

public:

   DtSimLocalEnvironmentalNetInterface(const DtString& name, 
      DtVrfObject* vrfObject,  
      DtReaderWriterRegistry* parentRegistry = 0,
      bool publishObject = true);

   DtSimLocalEnvironmentalNetInterface(
      const DtSimLocalEnvironmentalNetInterface & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   const DtSimLocalEnvironmentalNetInterface & operator=(const 
      DtSimLocalEnvironmentalNetInterface & orig);

   virtual ~DtSimLocalEnvironmentalNetInterface();

   virtual bool init(const DtEntityIdentifier& id = DtEntityIdentifier::nullId());

   virtual DtString type() const = 0;
   
   virtual void tick();

   virtual void setMinTickPeriod(double minTickPeriod);

   virtual double minTickPeriod() const;

   virtual void setMinTickPeriodVariance(double minTickPeriodVariance);

   virtual double minTickPeriodVariance() const;

   virtual void setNextTickTime(double nextTickTime);

   virtual double nextTickTime() const;

   virtual double calculateNextTickTime() const;

   virtual void onTick();

   virtual bool publisherUserSupplied() const;

   virtual void updatePublisher() = 0;

   virtual bool createPublisher(const DtEntityIdentifier& id = DtEntityIdentifier::nullId());

   virtual void destroyPublisher();

   virtual bool setEntityPublisher(DtEnvironmentProcessPublisher* publisher);

   virtual DtEnvironmentProcessPublisher* environmentalPublisher() const;

   virtual void setupNetworkRepository();

   DtVrfObject* vrfObject() const;

   virtual bool isLocal() const { return true; }
   virtual bool isEnvironmental() const { return true; }

   static DtSimLocalEnvironmentalNetInterface* isLocalEnvironmentalNetInterface(
      const DtSimObjectNetInterface * objNetInterface);

   static void verticesChanged(DtVrfObject*, void* usr);
   virtual void processVerticesChanged(DtVrfObject*);

#ifdef DtDIS



   static void setHeartbeatVariance(double variance);
   static double heartbeatVariance();
#endif

protected:

   virtual DtEnvironmentProcessPublisher* _createPublisher(const DtEntityIdentifier& id = DtEntityIdentifier::nullId()) const;

   virtual DtEnvironmentProcessRepository* _createSR() const;
      
protected:
   bool myPublisherUserSupplied;

   DtEnvironmentProcessPublisher* myEnvironmentalPublisher;  
   bool myPublishObject;
   DtSimManager* mySimManager;

   double myMinTickPeriod;
   double myMinTickPeriodVariance;
   double myNextTickTime;

   bool myVerticesChanged;
   bool myVerticesChangedCallbackRegistered;

   static double theHeartbeatVariance;
};