WSF
WsfInherentContrast.hpp
Go to the documentation of this file.
1// ****************************************************************************
2// CUI
3//
4// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
5//
6// Copyright 2003-2015 The Boeing Company. All rights reserved.
7//
8// The use, dissemination or disclosure of data in this file is subject to
9// limitation or restriction. See accompanying README and LICENSE for details.
10// ****************************************************************************
11
12#ifndef WSFINHERENTCONTRAST_HPP
13#define WSFINHERENTCONTRAST_HPP
14
15#include "wsf_mil_export.h"
16
17class UtScriptTypes;
18class WsfPlatform;
19class WsfScenario;
20#include "WsfSignature.hpp"
21
23class WSF_MIL_EXPORT WsfInherentContrast : public WsfSignature
24{
25public:
26 enum
27 {
29 };
30
32 WsfInherentContrast* Clone() const override = 0;
33
39 virtual float GetInherentContrast(WsfStringId aStateId, double aAzimuth, double aElevation) = 0;
40
45
46 static WsfStringId GetInputType(WsfPlatform* aPlatformPtr);
47
48 static WsfStringId GetState(WsfPlatform* aPlatformPtr);
49
50 static bool SetState(WsfPlatform* aPlatformPtr, WsfStringId aState);
51
52 static float GetScaleFactor(WsfPlatform* aPlatformPtr);
53
54 static bool SetScaleFactor(WsfPlatform* aPlatformPtr, float aScaleFactor);
55
56 static float GetValue(WsfPlatform* aPlatformPtr, double aAzimuth, double aElevation, bool aLogWarning = true);
57
60
61 static void RegisterScriptMethods(UtScriptTypes& aScriptTypes);
62 static void RegisterInterface(WsfScenario& aScenario);
63};
64
65#endif
UtStringId WsfStringId
WsfStringId – the same thing as UtStringId.
Definition WsfStringId.hpp:23
An object that represents the inherent contrast of a platform.
Definition WsfInherentContrast.hpp:24
static WsfStringId GetInputType(WsfPlatform *aPlatformPtr)
Definition WsfInherentContrast.cpp:84
static float GetValue(WsfPlatform *aPlatformPtr, double aAzimuth, double aElevation, bool aLogWarning=true)
Definition WsfInherentContrast.cpp:135
WsfInherentContrast * Clone() const override=0
static float GetScaleFactor(WsfPlatform *aPlatformPtr)
Definition WsfInherentContrast.cpp:112
static bool SetScaleFactor(WsfPlatform *aPlatformPtr, float aScaleFactor)
Definition WsfInherentContrast.cpp:122
virtual float GetInherentContrast(WsfStringId aStateId, double aAzimuth, double aElevation)=0
static WsfInherentContrast * GetObject(WsfPlatform *aPlatformPtr)
@ cSIGNATURE_INDEX
Index of signature within WsfSignatureList (must be unique).
Definition WsfInherentContrast.hpp:28
static void RegisterInterface(WsfScenario &aScenario)
Register the platform interface object on the prototype signature list in the specified scenario.
Definition WsfInherentContrast.cpp:168
static bool SetState(WsfPlatform *aPlatformPtr, WsfStringId aState)
Definition WsfInherentContrast.cpp:103
static WsfStringId GetState(WsfPlatform *aPlatformPtr)
Definition WsfInherentContrast.cpp:93
WsfInherentContrast()
Definition WsfInherentContrast.cpp:22
static void RegisterScriptMethods(UtScriptTypes &aScriptTypes)
Definition WsfInherentContrast.cpp:160
Platforms represent a entity within the simulation.
Definition WsfPlatform.hpp:115
Contains the data required to create a simulation, and acts as the entry point for input file process...
Definition WsfScenario.hpp:111
WsfSignature()
Definition WsfSignature.cpp:19
Copyrights Multiple, All Rights Reserved