WsfImageMessage.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 WSFIMAGEMESSAGE_HPP
#define WSFIMAGEMESSAGE_HPP
 
#include "wsf_export.h"
 
#include <memory>
 
class UtScriptClass;
class UtScriptTypes;
class WsfImage;
#include "WsfMessage.hpp"

 
class WSF_EXPORT WsfImageMessage : public WsfMessage
{
public:
   WsfImageMessage(WsfPlatform* aPlatformPtr, const WsfImage& aImage);
   ~WsfImageMessage() override;
 
   WsfMessage* Clone() const override;
 
   const char* GetScriptClassName() const override;
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);

   static WsfStringId GetTypeId();
   static const char* GetMessageType();

   WsfStringId GetComponentNameId() const override;
   WsfStringId GetComponentTypeId() const override;
   WsfStringId GetComponentModeId() const override;
 
   // Return the pointer to the image.  This pointer is valid ONLY during the
   // processing of the message.  If you need to retain the information then
   // you must clone the image!
 
   WsfImage* GetImage() const { return mImagePtr; }
 
protected:
   WsfImageMessage(const WsfImageMessage& aSrc); // For Clone();
   WsfImageMessage& operator=(const WsfImageMessage&) = delete;
 
private:
   WsfImage* mImagePtr;
};
 
#endif