simLocalEntityNetInterface.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2000 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: lclEntNetIf.h,v $ $Revision: 1.26 $ $State: Exp $
*******************************************************************************/




#ifndef DtSimLocalEntityNetInterface_H_
#define DtSimLocalEntityNetInterface_H_

#include "vrfobjcore/simEntityNetInterface.h"
#include <vl/globalObjectDesignator.h>
#include "vrfobjcore/vrfObject.h"

class DtObjectPublisher;


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

public:

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

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

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

   virtual ~DtSimLocalEntityNetInterface();

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

   virtual void onTick();
   
   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 bool publisherUserSupplied() const;

   virtual void updatePublisher() = 0;

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

   virtual void destroyPublisher() = 0;

   virtual DtObjectPublisher* publisher() = 0;

   virtual void updateNet();
   
   virtual void setupNetworkRepository() = 0;

   virtual void updateUuid() = 0;

   DtVrfObject * vrfObject() const;

   static bool isVrfGlobalId(const DtGlobalObjectDesignator& identifier);

   virtual bool isLocal() const { return true; }
    
   virtual bool isAggregate() const = 0;

   static DtSimLocalEntityNetInterface * isLocalEntityNetInterface(const 
      DtSimObjectNetInterface * objNetInterface);

   static void setVrfDataTimeThreshold(DtTime time);

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

protected:
   bool myPublisherUserSupplied;

   bool myPublishObject;

   DtSimManager* mySimManager;

   double myMinTickPeriod;
   double myMinTickPeriodVariance;
   double myNextTickTime;

   static double theHeartbeatVariance;

};

#endif