objectPublisherDIS.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/


#if DtDIS 


#ifndef DtDISObjectPublisher_H_
#define DtDISObjectPublisher_H_


#include <vlutil/vlAttributePduStrategy.h>
#include <vlutil/vlMachineTypes.h>
#include "objectId.h"
#include <vlutil/vlTime.h>

class DT_DLL_VL DtStateRepository;
class DT_DLL_VL DtExerciseConn;
class DT_DLL_VL DtPdu;
class DT_DLL_VL DtAttributePdu;
class DT_DLL_VL DtPduWithAttributeRecordSets;
class DT_DLL_VL DtStateRepositoryExtensionEncoder;
class DT_DLL_VL DtStateRepositoryExtensionDecoder;


class DT_DLL_VL DtObjectPublisher
{
public:

   typedef DtAttributePdu * (*DtNonCoupledAttributePduCreator)(const DtPduWithAttributeRecordSets*, void*);

   DtObjectPublisher(DtExerciseConn* conn,
      DtStateRepository* stateRep,
      DtStateRepository* asSeenByRemote, 
      bool okToDeleteStateRep = true);

   virtual ~DtObjectPublisher();

private:

   DtObjectPublisher(const DtObjectPublisher& orig);

   DtObjectPublisher& operator= (const DtObjectPublisher& orig);

public:
   
   virtual DtStateRepository* stateRep();

   virtual DtStateRepository* sr();

   virtual DtExerciseConn* exerciseConn();

   virtual const DtObjectId& localId() const = 0;
   virtual const DtObjectId& id() const = 0;
   virtual const DtGlobalObjectDesignator& globalId() const = 0;

   virtual void forceUpdate()=0;

   virtual bool tick() = 0;

   virtual bool parallelTick();

   virtual void setTimeThreshold(DtTime time);
   virtual DtTime timeThreshold() const; 

   virtual void setRelLocTimeThreshold( DtTime time );
   virtual DtTime relLocTimeThreshold() const;

   virtual DtStateRepository* approximateRemoteStateRep();

   virtual DtTime lastTimeUpdated() const;
   virtual DtTime lastTimeAttrUpdated() const;

   virtual DtTime lastSimTimeUpdated() const;

   virtual void setUseCustomThreshold(bool useCustom);

   virtual bool useCustomThreshold();

   virtual void setAttributePduStrategy(DtAttributePduStrategy strat);
   virtual DtAttributePduStrategy attributePduStrategy() const;

   virtual void encodeExtensions(DtStateRepository* stateRep, const DtStateRepository &asSeenByRemote);

   virtual void decodeExtensions(DtPdu* pdu, const DtStateRepository &stateRep);

   virtual void setUpdateRateWarningThreshold(unsigned short updatesPerSecond);
   virtual unsigned short updateRateWarningThreshold() const;

   virtual void checkForUpdateRateWarning() const;

public:

   static void setDfltTimeThreshold(DtTime time);   

   static DtTime dfltTimeThreshold();

   static void setDfltUpdateRateWarningThreshold(unsigned short updatesPerSecond);

   static unsigned short dfltUpdateRateWarningThreshold();

   static void setDfltRelLocTimeThreshold( DtTime time );

   static DtTime dfltRelLocTimeThreshold();

   static DtNonCoupledAttributePduCreator setDefaultNonCoupledAttributePduCreator(DtNonCoupledAttributePduCreator creator);
   static DtNonCoupledAttributePduCreator defaultNonCoupledAttributePduCreator(void);

   DtNonCoupledAttributePduCreator setNonCoupledAttributePduCreator(DtNonCoupledAttributePduCreator creator);
   DtNonCoupledAttributePduCreator nonCoupledAttributePduCreator(void);

protected:


   virtual void send(DtPdu* pdu) const;


protected:

   DtExerciseConn    *myExConn;
   DtStateRepository *myStateRep;
   DtStateRepository *myAsSeenByRemote;
   bool               myOkToDeleteStateRepFlag;
   bool               myUseCustomThreshold;

   DtTime             myTimeThreshold;
   DtTime             myRelLocTimeThreshold;

   mutable DtTime     mySimTimeLastUpdate;

   mutable DtTime     myRealTimeLastUpdate;
   mutable DtTime     myRealTimeLastAttrUpdate;

   mutable DtTime     myLastSpamCheckTime;

   mutable unsigned short      myNumberOfPdusPerSecond;

   mutable unsigned short      myUpdateRateWarningThreshold;

   mutable bool myCanWarn;

   // Publisher instance specific override for non-coupled Attribute PDU creation
   DtNonCoupledAttributePduCreator myNonCoupledAttributePduCreator;

   // Default non-coupled Attribute PDU creator
   static DtNonCoupledAttributePduCreator theDefaultNonCoupledAttributePduCreator;

   // How we should send attribute PDUs
   DtAttributePduStrategy myAttributePduStrategy;

   //List of State Repository Extension Encoders
   std::vector<DtStateRepositoryExtensionEncoder*> myStateRepositoryExtensionEncoderList;

   //List of State Repository Extension Decoders
   std::vector<DtStateRepositoryExtensionDecoder*> myStateRepositoryExtensionDecoderList;

protected:

   static DtTime              theDfltTimeThreshold;
   static DtTime              theDfltRelLocTimeThreshold;
   static unsigned short      theDfltUpdateRateWarningThreshold;

};

inline DtStateRepository* DtObjectPublisher::stateRep()
{
   return myStateRep;
}

inline DtStateRepository* DtObjectPublisher::sr()
{
   return myStateRep;
}

inline DtExerciseConn* DtObjectPublisher::exerciseConn()
{
   return myExConn;
}

inline DtStateRepository* DtObjectPublisher::approximateRemoteStateRep()
{
  return myAsSeenByRemote;
}

#endif   //DtObjectPublisher_H_
#endif   //DtDIS