WsfXIO_PublisherHelper.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFXIO_PUBLISHERHELPER_HPP
#define WSFXIO_PUBLISHERHELPER_HPP
 
#include "wsf_export.h"
 
class WsfSimulation;
class WsfXIO_Interface;
#include "xio/WsfXIO_Publisher.hpp"

 
class WSF_EXPORT WsfXIO_PublisherHelper
{
public:
   friend class PublishEvent;
 
   typedef WsfXIO_PublishKey                                              PublisherKey;
   typedef WsfXIO_Publisher::SubscriptionId                               SubscriptionId;
   typedef WsfXIO_PublishFilter                                           SubscriptionFilter;
   typedef WsfXIO_Publisher::SubscribeCallback                            SubscriptionCallback;
   typedef std::map<SubscriptionId, WsfXIO_Publisher::SubscribeCallback*> Subscriptions;
 
   WsfXIO_PublisherHelper(WsfXIO_Interface* aInterfacePtr, WsfSimulation& aSimulation);
 
   virtual ~WsfXIO_PublisherHelper();
 
   void SetStateDirty(double aSimTime = -1.0);
 
   void Publish(const PublisherKey& aKey, const std::string& aData);
 
   bool GetPublishedData(const PublisherKey& aKey, std::string& aData) const;
 
   bool HasSubscription(const SubscriptionId& aSubscriptionId) const;
 
   SubscriptionId Subscribe(const SubscriptionFilter& aSubscriptionFilter, SubscriptionCallback* aSubscriptionCallbackPtr);
 
   bool Unsubscribe(const SubscriptionId& aSubscriptionId);
 
protected:
   virtual void PublishState(double aSimTime) {}
 
private:
   WsfXIO_Interface* mInterfacePtr;
   WsfSimulation&    mSimulation;
   Subscriptions     mSubscriptions;
   bool              mStateDirty;
};
 
#endif