WsfControlMessage.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 WSFCONTROLMESSAGE_HPP
#define WSFCONTROLMESSAGE_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
 
class UtScriptClass;
class UtScriptTypes;
#include "WsfMessage.hpp"
class WsfPlatform;
#include "WsfRoute.hpp"
#include "WsfStringId.hpp"
#include "WsfTrack.hpp"
#include "WsfTrackId.hpp"

 
class WSF_EXPORT WsfControlMessage : public WsfMessage
{
public:
   WsfControlMessage(); // For XIO (de)serialization.
   WsfControlMessage(WsfPlatform* aPlatformPtr);
 
   WsfMessage* Clone() const override;
 
   const char* GetScriptClassName() const override;
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);
 
   static WsfStringId GetTypeId();


   WsfStringId GetFunction() const;
 
   void SetFunction(WsfStringId aFunction);



   const WsfTrackId& GetRequestId() const { return mRequestId; }

   void SetRequestId(const WsfTrackId& aRequestId) { mRequestId = aRequestId; }



   WsfStringId GetResourceId() const { return mResourceId; }
 
   std::string GetResource() const;

   void SetResourceId(WsfStringId aResourceId) { mResourceId = aResourceId; }
 
   void SetResource(const std::string& aResource);



   const WsfTrack& GetTrack() const { return mTrack; }

   WsfTrack& GetTrack() { return mTrack; }
 
   void SetTrack(const WsfTrack& aTrack);



   const WsfRoute& GetRoute() const { return mRoute; }

   WsfRoute& GetRoute() { return mRoute; }
 
   void SetRoute(const WsfRoute& aRoute);

   template<typename T>
   void Serialize(T& aBuff)
   {
      WsfMessage::Serialize(aBuff);
      aBuff& mRequestId& mResourceId& mTrack& mRoute;
   }
 
protected:
   WsfControlMessage(const WsfControlMessage& aSrc);
   WsfControlMessage& operator=(const WsfControlMessage& aRhs);
 
   WsfTrackId  mRequestId;
   WsfStringId mResourceId; 
   WsfTrack    mTrack;      
   WsfRoute    mRoute;      
};
 
#endif