WsfInternalLinks.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 WSFINTERNALLINKS_HPP
#define WSFINTERNALLINKS_HPP
 
#include "wsf_export.h"
 
#include <cassert>
#include <vector>
 
class UtInput;
class WsfMessage;
class WsfPlatformPart;
#include "WsfStringId.hpp"

class WSF_EXPORT WsfInternalLinks
{
public:
   WsfInternalLinks();
   WsfInternalLinks(const WsfInternalLinks& aSrc);
   WsfInternalLinks& operator=(const WsfInternalLinks& aRhs);
   ~WsfInternalLinks();

   bool HasLinks() const { return mHasLinks; }
 
   bool Initialize(double aSimTime, WsfPlatformPart* aPlatformPartPtr);
 
   bool ProcessInput(UtInput& aInput);
 
   void AddRecipient(WsfStringId aRecipientId);
   bool AddRecipient(WsfPlatformPart* aRecipientPtr);
 
   bool SetStatus(WsfStringId aRecipientId, bool aActive);
   bool RemoveLink(WsfStringId aRecipientId);
 
   void SendMessage(double aSimTime, const WsfMessage& aMessage);
 
   void SendMessage(double aSimTime, const WsfMessage& aMessage, WsfStringId aRecipientId);

   unsigned int GetRecipientCount() const
   {
      assert(mIsInitialized);
      return static_cast<unsigned int>(mRecipientPtrs.size());
   }
 
   struct Addressee
   {
      Addressee();
      Addressee(WsfStringId aNameId);
      Addressee(const Addressee& aSrc);
      Addressee& operator=(const Addressee& aRhs);
      ~Addressee()       = default;
 
      bool Activate(WsfPlatformPart* aPartPtr);
      bool Deactivate();
 
      WsfStringId      mNameId;
      WsfPlatformPart* mPartPtr;
      bool             mIsActive;
   };

   WsfPlatformPart* GetRecipientEntry(unsigned int aEntry) const
   {
      assert(mIsInitialized);
      const Addressee& link = *mRecipientPtrs[aEntry];
      return (link.mIsActive) ? link.mPartPtr : nullptr;
   }
 
protected:
   void ClearRecipients();
 
private:
   bool LinkRecipient(WsfStringId aRecipientId);
   bool LinkRecipient(WsfPlatformPart* aRecipientPtr);

   WsfPlatformPart* mPlatformPartPtr;

   std::vector<Addressee*> mRecipientPtrs;

   bool mDebugLinks;

   bool mIsInitialized;

   bool mHasLinks;
};
 
#endif