WsfCommProtocolAdHoc.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2019 Infoscitex, a DCS 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 WSFCOMMPROTOCOLADHOC_HPP
#define WSFCOMMPROTOCOLADHOC_HPP
 
#include "wsf_export.h"
 
#include "WsfCommRouterProtocolInterface.hpp"
#include "WsfRandomVariable.hpp"
class WsfScenario;
#include "script/WsfScriptContext.hpp"
 
namespace wsf
{
namespace comm
{
namespace router
{

class ProtocolAdHoc : public ProtocolInterface
{
public:
   static ProtocolAdHoc* Find(const Router& aParent);
   static ProtocolAdHoc* FindOrCreate(Router& aParent);
 
   ProtocolAdHoc(const WsfScenario& aScenario);
   ProtocolAdHoc(const ProtocolAdHoc& aSrc);
   ~ProtocolAdHoc() override = default;


   WsfComponent*  CloneComponent() const override;
   const int*     GetComponentRoles() const override;
   void*          QueryInterface(int aRole) override;
   int            GetPriority() const override;
   ProtocolAdHoc* Clone() const override;
 
   bool Send(double aSimTime, Router::SendData& aData) override;
 
   std::vector<Address> Routing(double         aSimTime,
                                const Address& aSendingInterface,
                                size_t&        aHopNumber,
                                double&        aCost,
                                const Message& aMessage) override;
 
   const char* GetScriptClassName() const override { return "WsfCommProtocolAdHoc"; }
 
   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;
   void Setup() override;


   bool          ShouldPropagateTruth() const override { return false; }
   graph::Graph* GetGraph() const override { return mGraph.get(); }


   void ExecuteOnCommAdded(double aSimTime, const Address& aComm);
   void ExecuteOnCommRemoved(double aSimTime, const Address& aComm);
   void ExecuteOnConnectionAdded(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress);
   void ExecuteOnConnectionRemoved(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress);
   Address ExecuteOnMessageRouting(double aSimTime, const Address& aInterface, const Message& aMessage);


   void PerfectCommAdded(double aSimTime, Comm* aCommPtr) override;
   void PerfectCommRemoved(double aSimTime, Comm* aCommPtr) override;
   void PerfectConnectionAdded(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress) override;
   void PerfectConnectionRemoved(double aSimTime, const Address& aSourceAddress, const Address& aDestinationAddress) override;

   bool ValidNetwork(const Address& aAddress) const;

   void InitializeState();
 
private:
   const WsfScenario&                mScenario;
   std::unique_ptr<graph::Graph>     mGraph{nullptr};
   std::unique_ptr<WsfScriptContext> mContextPtr{nullptr};
 
   WsfRandomVariable mOnCommAddedDelay{WsfRandomVariable::cCONSTANT, 0.0, 0.0, WsfRandomVariable::cNON_NEGATIVE};
   WsfRandomVariable mOnCommRemovedDelay{WsfRandomVariable::cCONSTANT, 0.0, 0.0, WsfRandomVariable::cNON_NEGATIVE};
   WsfRandomVariable mOnConnectionAddedDelay{WsfRandomVariable::cCONSTANT, 0.0, 0.0, WsfRandomVariable::cNON_NEGATIVE};
   WsfRandomVariable mOnConnectionRemovedDelay{WsfRandomVariable::cCONSTANT, 0.0, 0.0, WsfRandomVariable::cNON_NEGATIVE};
 
   UtScript* mOnCommAdded{nullptr};
   UtScript* mOnCommRemoved{nullptr};
   UtScript* mOnConnectionAdded{nullptr};
   UtScript* mOnConnectionRemoved{nullptr};
   UtScript* mOnMessageRouting{nullptr};
 
   std::shared_ptr<int> mEvents{std::make_shared<int>(0)};
};
 
} // namespace router
} // namespace comm
} // namespace wsf
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(wsf::comm::router::ProtocolAdHoc, cWSF_COMPONENT_COMM_ROUTER_PROTOCOL_AD_HOC);
 
#endif