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

class WSF_EXPORT WsfStatusMessage : public WsfMessage
{
public:
   WsfStatusMessage(); // For XIO (de)serialization
   WsfStatusMessage(WsfSimulation& aSimulation);
   WsfStatusMessage(WsfPlatform* aPlatformPtr);
   WsfStatusMessage(WsfStringId aStatusId, 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 GetStatusId() const { return GetSubType(); }
 
   const std::string& GetStatus() const;

   void SetStatusId(WsfStringId aStatusId) { SetSubType(aStatusId); }
 
   void SetStatus(WsfStringId aStatus);



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

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



   WsfStringId GetSystemNameId() const { return mSystemNameId; }
 
   std::string GetSystemName() const;

   void SetSystemNameId(WsfStringId aSystemNameId) { mSystemNameId = aSystemNameId; }
 
   void SetSystemName(const std::string& aSystemName);


   WsfPlatform* GetPlatform() const;
   size_t       GetPlatformIndex() const { return mPlatformIndex; }
 
   void SetPlatform(WsfPlatform* aPlatformPtr);
   void SetPlatformIndex(size_t aPlatformIndex) { mPlatformIndex = aPlatformIndex; }

   template<typename T>
   void Serialize(T& aBuff)
   {
      WsfMessage::Serialize(aBuff);
      aBuff& mRequestId& mSystemNameId& mPlatformIndex;
   }
 
protected:
   // Using the default copy constructor.
   // WsfStatusMessage(const WsfStatusMessage& aSrc);

   WsfTrackId mRequestId;

   WsfStringId mSystemNameId;

   size_t mPlatformIndex;
};
 
#endif