simAggregateLocalEntityNetInterface.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/simLocalEntityNetInterface.h"
#include "vrfobjcore/vrfObjectStateRepository.h"
#include <vl/variableDatumRecord.h>

class DtVrfAggregatePublisher;
class DtExtAggregateStateRepository;
class DtVrfAggregateStateRepository;

class DT_DLL_vrfobjcore DtSimAggregateLocalEntityNetInterface : public DtSimLocalEntityNetInterface
{
protected:

   DtSimAggregateLocalEntityNetInterface();

public:

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

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

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

   virtual ~DtSimAggregateLocalEntityNetInterface();

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

   virtual void updateNet();
   
   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 void updatePublisher();

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

   virtual void destroyPublisher();

   virtual bool setAggregatePublisher(DtVrfAggregatePublisher * publisher);

   virtual void setupNetworkRepository();

   virtual DtVrfAggregatePublisher * aggregatePublisher() const;

   virtual DtExtAggregateStateRepository * aggregateNetworkState() const;

   virtual DtVrfAggregateStateRepository * aggregateLocalState() const;

   virtual bool setUserVariableDatum( int userRecordNumber, 
                                      const DtVariableDatumRecord& record);

   virtual bool getUserVariableDatum( int userRecordNumber,
                                      DtVariableDatumRecord& rec);

   virtual bool encodeVariableDatum();

   virtual bool isANetSubordinate(const DtGlobalObjectDesignator& 
      globalId);

   virtual bool isPseudoAggregate() const { return false; }

   virtual bool isAggregate() const { return true; }

   virtual DtString type() const;

   virtual void setForceUpdate(bool flag);

   static DtSimAggregateLocalEntityNetInterface * 
      isAggregateLocalEntityNetInterface(const DtSimObjectNetInterface * 
      objNetInterface);

   static DtSimObjectNetInterface * creator(const DtString & name, 
      DtVrfObject* vrfObject, 
      DtReaderWriterRegistry* parentRegistry,
      bool publishObject);

protected:
   virtual bool updateVrfDataAsSeenByRemote();

protected:

   DtVrfAggregatePublisher* myAggregatePublisher;

   double myMinTickPeriod;
   double myMinTickPeriodVariance;
   double myNextTickTime;

   bool myFirstPause;
   bool myForceUpdate;
};