WsfVisualPart.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 WSFVISUALPART_HPP
#define WSFVISUALPART_HPP
 
#include "wsf_export.h"
 
#include <vector>
 
class UtInput;
#include "WsfArticulatedPart.hpp"

class WSF_EXPORT WsfVisualPart : public WsfArticulatedPart
{
public:
   WsfVisualPart(const WsfScenario& aScenario);
   WsfVisualPart& operator=(const WsfVisualPart&) = delete;
   ~WsfVisualPart() override;


   WsfComponent* CloneComponent() const override { return Clone(); }
   int           GetComponentInitializationOrder() const override { return cWSF_INITIALIZE_ORDER_VISUAL_PART; }
   const int*    GetComponentRoles() const override;
   void*         QueryInterface(int aRole) override;


   const char* GetScriptClassName() const override;
   WsfVisualPart* Clone() const override { return new WsfVisualPart(*this); }
   bool           Initialize(double aSimTime) override;
   bool           ProcessInput(UtInput& aInput) override;
   void           Update(double aSimTime) override;

   double GetUpdateInterval() const override { return mUpdateInterval; }

   void SetIcon(const std::string& aIcon) { mIcon = aIcon; }
   const std::string& GetIcon() const { return mIcon; }

   void SetUpdateInterval(double aUpdateInterval) override { mUpdateInterval = aUpdateInterval; }


   void TurnOff(double aSimTime) override;
   void TurnOn(double aSimTime) override;
   void SetNonOperational(double aSimTime) override;
   void SetOperational(double aSimTime) override;
   void PartBroken(double aSimTime) override;
 
protected:
   WsfVisualPart(const WsfVisualPart& aSrc);
 
private:
   double mUpdateInterval;

   unsigned int mRequestId;

   std::vector<unsigned int> mActiveRequestList;
 
   std::string mIcon;
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfVisualPart, cWSF_COMPONENT_VISUAL)
 
#endif