WsfRandomVariable.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.
// ****************************************************************************
// ****************************************************************************
// Updated by Infoscitex, a DCS Company.
// ****************************************************************************
 
#ifndef WSFRANDOMVARIABLE_HPP
#define WSFRANDOMVARIABLE_HPP
 
#include "wsf_export.h"
 
#include "UtInput.hpp"
#include "UtRandom.hpp"
#include "UtScriptAccessible.hpp"
#include "UtScriptClassDefine.hpp"
class WsfScriptContext;
class WsfSimulation;
#include "WsfVariable.hpp"

class WSF_EXPORT WsfRandomVariable : public UtScriptAccessible
{
public:
   enum Distribution
   {
      cCONSTANT,    
      cEXPONENTIAL, 
      cLOG_NORMAL,  
      cNORMAL,      
      cUNIFORM      
   };

   enum Constraints
   {
      cNO_CONSTRAINT, 
      cPOSITIVE,      
      cNON_NEGATIVE   
   };
 
   // NOTE: The default (member-wise) copy constructor and assignment operator are used.
   //       Copying or assigning a 'Initialized variable is OK as long as the copy would also
   //       refer to the same script context.
 
   WsfRandomVariable();
   WsfRandomVariable(Constraints aConstraints);
   WsfRandomVariable(double aConstant, Constraints aConstraints);
   WsfRandomVariable(double aMinimum, double aMaximum, Constraints aConstraints);
   WsfRandomVariable(Distribution aDistribution, double aParameter1, double aParameter2, Constraints aConstraints);
   WsfRandomVariable(Distribution               aDistribution,
                     const WsfVariable<double>& aParameter1,
                     const WsfVariable<double>& aParameter2,
                     Constraints                aConstraints);
 
   bool Initialize(const std::string& aName, WsfComponent* aObjectPtr, WsfScriptContext* aContextPtr, WsfSimulation& aSimulation);
 
   void ProcessInput(UtInput& aInput, UtInput::ValueType aValueType);
 
   void DefineDistribution(Distribution               aDistribution,
                           const WsfVariable<double>& aParameter1,
                           const WsfVariable<double>& aParameter2,
                           Constraints                aConstraints);
 
   double Draw();

   double LastDraw() const { return mValue; }


   double       GetParameterFirst() const { return mParameter1; }
   double       GetParameterSecond() const { return mParameter2; }
   Constraints  GetConstraints() const { return mConstraints; }
   Distribution GetDistribution() const { return mDistribution; }







   double operator==(double aRhs) const { return (mValue == aRhs); }
   double operator!=(double aRhs) const { return (mValue != aRhs); }
   double operator<(double aRhs) const { return (mValue < aRhs); }



   operator double() const { return mValue; }
 
   const char* GetScriptClassName() const override { return "WsfRandomVariable"; }

   void SetGenerator(WsfSimulation& aSim);
 
protected:
   void SetDefaultValues();

   ut::Random* mRandomPtr;

   ut::Random mRandom;

   Distribution mDistribution;

   Constraints mConstraints;

   double mValue;

   WsfVariable<double> mParameter1;

   WsfVariable<double> mParameter2;
};
 
class WSF_EXPORT WsfScriptRandomVariableClass : public UtScriptClass
{
public:
   WsfScriptRandomVariableClass(const std::string& aClassName, UtScriptTypes* aTypesPtr);
 
   ~WsfScriptRandomVariableClass() override = default;
 
   void* Create(const UtScriptContext& aInstance) override;
   void* Clone(void* aObjectPtr) override;
   void  Destroy(void* aObjectPtr) override;
 
   UT_DECLARE_SCRIPT_METHOD(Set);
 
   UT_DECLARE_SCRIPT_METHOD(Draw);
   UT_DECLARE_SCRIPT_METHOD(LastDraw);
 
   UT_DECLARE_SCRIPT_METHOD(GetFirstParameter);
   UT_DECLARE_SCRIPT_METHOD(GetSecondParameter);
   UT_DECLARE_SCRIPT_METHOD(GetConstraint);
   UT_DECLARE_SCRIPT_METHOD(GetDistribution);
};
 
#endif