WsfPlatformObserver.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 WSFPLATFORMOBSERVER_HPP
#define WSFPLATFORMOBSERVER_HPP
 
#include <string>
 
#include "UtCallback.hpp"
class WsfCallback;
#include "wsf_export.h"
class WsfMessage;
class WsfPlatform;
class WsfRoute;
class WsfTrack;
class WsfSimulation;
 
namespace WsfObserver
{

enum AppearanceType
{
   cAPPEARANCE_WORD,
   cCONCEALMENT_FACTOR,
   // The following two items allow for a maximum of 100 signature types.
   cSIGNATURE_STATE_START        = 100, 
   cSIGNATURE_STATE_LIMIT        = 199, 
   cSIGNATURE_SCALE_FACTOR_START = 200, 
   cSIGNATURE_SCALE_FACTOR_LIMIT = 299  
};
 
using CommentCallback                   = UtCallbackListN<void(double, WsfPlatform*, const std::string&)>;
using CrashedIntoGroundCallback         = UtCallbackListN<void(double, WsfPlatform*)>;
using ExecuteCallbackCallback           = UtCallbackListN<void(double, WsfPlatform*, const WsfCallback&)>;
using GroupAddedCallback                = UtCallbackListN<void(const std::string&, const std::string&)>;
using NavigationStatusChangedCallback   = UtCallbackListN<void(double, WsfPlatform*, const std::string&)>;
using PlatformAppearanceChangedCallback = UtCallbackListN<void(double, WsfPlatform*, AppearanceType)>;
using PlatformAddedCallback             = UtCallbackListN<void(double, WsfPlatform*)>;
using PlatformBrokenCallback            = UtCallbackListN<void(double, WsfPlatform*)>;
using PlatformDamageChangedCallback     = UtCallbackListN<void(double, WsfPlatform*)>;
using PlatformDeletedCallback           = UtCallbackListN<void(double, WsfPlatform*)>;
using PlatformInitializedCallback       = UtCallbackListN<void(double, WsfPlatform*)>;
using PlatformOmittedCallback           = UtCallbackListN<void(double, WsfPlatform*)>;
 
WSF_EXPORT CommentCallback&                   Comment(const WsfSimulation* aSimulationPtr);
WSF_EXPORT CrashedIntoGroundCallback&         CrashedIntoGround(const WsfSimulation* aSimulationPtr);
WSF_EXPORT ExecuteCallbackCallback&           ExecuteCallback(const WsfSimulation* aSimulationPtr);
WSF_EXPORT GroupAddedCallback&                GroupAdded(const WsfSimulation* aSimulationPtr);
WSF_EXPORT NavigationStatusChangedCallback&   NavigationStatusChanged(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformAppearanceChangedCallback& PlatformAppearanceChanged(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformDamageChangedCallback&     PlatformDamageChanged(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformAddedCallback&             PlatformAdded(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformBrokenCallback&            PlatformBroken(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformDeletedCallback&           PlatformDeleted(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformInitializedCallback&       PlatformInitialized(const WsfSimulation* aSimulationPtr);
WSF_EXPORT PlatformOmittedCallback&           PlatformOmitted(const WsfSimulation* aSimulationPtr);
} // namespace WsfObserver

struct WSF_EXPORT WsfPlatformObserver
{
   WsfObserver::CommentCallback Comment;

   WsfObserver::CrashedIntoGroundCallback CrashedIntoGround;

   WsfObserver::ExecuteCallbackCallback ExecuteCallback;

   WsfObserver::GroupAddedCallback GroupAdded;

   WsfObserver::NavigationStatusChangedCallback NavigationStatusChanged;

   WsfObserver::PlatformAddedCallback PlatformAdded;

   WsfObserver::PlatformAppearanceChangedCallback PlatformAppearanceChanged;

   WsfObserver::PlatformBrokenCallback PlatformBroken;

   WsfObserver::PlatformDamageChangedCallback PlatformDamageChanged;

   WsfObserver::PlatformDeletedCallback PlatformDeleted;

   WsfObserver::PlatformInitializedCallback PlatformInitialized;

   WsfObserver::PlatformOmittedCallback PlatformOmitted;
};
 
#endif