vrfEntityPublisher.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vrfExtObjects/extendedAttributesInitializer.h>
#include <vrfExtObjects/vrfObjectIdGenerator.h>
#include <vl/dataInteraction.h>
#include <vl/entityPublisher.h>
#include <readerWriter/rwProperties.h>

#ifdef DtDIS
#  include <vl/diGuyCustomPduEncoder.h>
#endif

#ifdef DtDIS
typedef DtEntityStateEncoder DtEntPublisherEncoder;
typedef DtEntityStateDecoder DtEntPublisherDecoder;
#else // DtHLA
typedef DtHlaStateEncoder DtEntPublisherEncoder;
typedef DtHlaStateDecoder DtEntPublisherDecoder;
#endif

class DtExtEntityStateRepository;
class DtEntityType;
class DtBaseEntityStateRepository;
class DtObjectClassChooser;
class DtSimulationAddress;
class DtSimInterfaceContent;

namespace makVrfVrlinkExtToolkit
{
   class DtExtendedAttributesObjectPublisher;
}

class DT_DLL_vrfExtObjects DtVrfEntityPublisher
{

public:

   DtVrfEntityPublisher(
      const DtEntityType& type, DtExerciseConn* conn,
#if DtHLA
      const DtGlobalObjectDesignator& glId = DtGlobalObjectDesignator::nullId(),
#endif
      const DtEntityIdentifier& entId = DtEntityIdentifier::nullId(),
      DtRwProperties* stateProps = 0, DtRwProperties* paramProps = 0);

   DtVrfEntityPublisher(
      const DtEntityType& type, DtExerciseConn* conn,
#if DtHLA
      const DtGlobalObjectDesignator& glId = DtGlobalObjectDesignator::nullId(),
#endif
      const DtEntityIdentifier& entId = DtEntityIdentifier::nullId(),
      const DtRwProperties& stateProps = DtRwProperties::emptyProperties(),
      const DtRwProperties& paramProps = DtRwProperties::emptyProperties());

   virtual ~DtVrfEntityPublisher();

   virtual bool tick(
#ifdef DtHLA
   bool& extAttrPublisherTick
#endif
   );

   virtual DtExtEntityStateRepository* entityProcessStateRep();
   virtual DtExtEntityStateRepository* entityStateRep();
   virtual DtExtEntityStateRepository* ensr();

#ifdef DtHLA
   virtual DtEntPublisherDecoder* decoder();

   virtual DtEntPublisherEncoder* encoder();
#endif

   virtual void setPublishesDiGuyInfo(bool has);
   
   virtual bool publishesDiGuyInfo();
   
#ifdef DtDIS
   virtual void setSendDiGuyPdus(bool yesNo);

   virtual bool sendDiGuyPdus() const;

   virtual void createAndSendDiGuyPdus();
#endif

   DtStateRepository* sr()
   {
      return myPublisher->sr();
   }

#if DtHLA
   const DtString& name() const
   {
      return myPublisher->name();
   }
#endif

   virtual const DtObjectId& id() const;

   virtual const DtObjectId& localId() const;

   virtual const DtGlobalObjectDesignator& globalId() const;

   virtual void forceUpdate();

   virtual bool sendVrfObjectData();

   virtual DtEntityPublisher* entityPublisher();

   virtual void setSendVrfObjectDataRecord(bool shouldSend);

   static void setInitializer(DtExtendedAttributesInitializerPtr init);
   
   static DtExtendedAttributesInitializerPtr initializer();

#if DtHLA
   static void setObjectClassChooser(DtObjectClassChooserPtr chooser);

   static DtObjectClassChooserPtr objectClassChooser();
#endif
   
   static void setVrfDataTimeThreshold(DtTime time);
   static DtTime vrfDataTimeThreshold();

private:

   DtVrfEntityPublisher(const DtVrfEntityPublisher&);
   
   DtVrfEntityPublisher& operator=(const DtVrfEntityPublisher&);
   
protected:

   DtVrfEntityPublisher();

   void initialize(const DtEntityType& type, DtExerciseConn* conn,
#if DtHLA
      const DtGlobalObjectDesignator& glId,
#endif
      const DtEntityIdentifier& entId);

   virtual bool sendVrfDataUpdate();

   virtual bool needsVrfObjectDataUpdate();

   virtual bool sendMessage(const DtSimulationAddress& receiver,
      DtSimInterfaceContent* message);
   virtual bool setContentForNet(DtDataInteraction* dataInter,
      DtSimInterfaceContent* content) const;
   virtual void sendMessageInteraction(const DtSimulationAddress& receiver,
      DtDataInteraction& data);

   static void dataInteractionCallback(DtDataInteraction* i, void* usr);

   virtual void processSendVrfObjectDataMessage(DtDataInteraction* interaction);
   
public:

   virtual void processDataInteraction(DtDataInteraction* i);

protected:

   DtEntityPublisher* myPublisher;
   
   // For heartbeating for DtIfVrfObjectData messages
   DtTime myTimeLastVrfDataSend;
   static DtTime theVrfDataTimeThreshold;
   bool myPublishesDIGuyInfo; // true if there is DI-Guy info to be published

   static bool myDiGuyEncodersSetup;

#if DtHLA
   makVrfVrlinkExtToolkit::DtExtendedAttributesObjectPublisher* myExtAttrPublisher;

   static DtObjectClassChooserPtr theObjectClassChooser;
#endif

   static DtExtendedAttributesInitializerPtr theInitializer;
};