WindLabAPI::IrpsWLRandomness Class Reference

An abstract class representing a randomness provider. More...

#include <IrpsWLRandomness.h>

Public Member Functions
virtual bool	ComputeRandomValue (const WindLabSimulationData &Data, double &dValue)=0
	Generate a random value.
virtual bool	GenerateRandomMatrixFP (const WindLabSimulationData &Data, mat &dRandomValueArray)=0
	Generate the random value matrix for all frequency increments and locations.
virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.
virtual	~IrpsWLRandomness ()
	Virtual destructor for IrpsWLRandomness class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureRandomness
virtual const char *	getViewProviderName () const
	WindLabFeatureRandomness (void)
	Constructor.
virtual	~WindLabFeatureRandomness ()
virtual short	mustExecute () const override
Public Member Functions inherited from WindLabAPI::WindLabFeature
	WindLabFeature (void)
	Constructor.
virtual	~WindLabFeature ()
	destructor

Additional Inherited Members
Protected Member Functions inherited from WindLabAPI::WindLabFeatureRandomness
virtual App::DocumentObjectExecReturn *	recompute () override
	recompute only this object
virtual App::DocumentObjectExecReturn *	execute () override
	recalculate the feature
virtual void	onChanged (const App::Property *prop) override
Protected Member Functions inherited from WindLabAPI::WindLabFeature
virtual PyObject *	getPyObject () override
Protected Attributes inherited from WindLabAPI::WindLabFeature
Py::SmartPtr	PythonObject

Detailed Description

An abstract class representing a randomness provider.

This is a pure virtual class (interface) that defines the interface for randomness providers. Random phenomenon exhibits random and fluctuating behavior that needs to be accurately represented in simulations to capture both long-term trends and short-term fluctuations. One of the key elements in the simulation process is the incorporation of random phases in the construction of the phenomenon. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLRandomness()

virtual WindLabAPI::IrpsWLRandomness::~IrpsWLRandomness ( )

virtual

Virtual destructor for IrpsWLRandomness class.

Provides proper cleanup in case a derived class object is destroyed.

Member Function Documentation

ComputeRandomValue()

virtual bool WindLabAPI::IrpsWLRandomness::ComputeRandomValue ( const WindLabSimulationData & Data, double & dValue )

pure virtual

Generate a random value.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dValue	a value to be updated. This is the generated random value.

Returns

return true if the computation is successful and false in case of failure.

Referenced by WindLabAPI::CRPSWindLabFramework::ComputeRandomValue().

GenerateRandomMatrixFP()

virtual bool WindLabAPI::IrpsWLRandomness::GenerateRandomMatrixFP ( const WindLabSimulationData & Data, mat & dRandomValueArray )

pure virtual

Generate the random value matrix for all frequency increments and locations.

Parameters

Data	the simulation data containing all the simulation parameters input by the user..
dMatrix	a matrix to be updated. It should contain the generated random values matrix.

Returns

return true if the computation is successful and false in case of failure.

Referenced by WindLabAPI::CRPSWindLabFramework::GenerateRandomMatrixFP().

OnInitialSetting()

virtual bool WindLabAPI::IrpsWLRandomness::OnInitialSetting ( const WindLabSimulationData & Data )

pure virtual

Allows to do any initial taks before any of the other methods is called.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.

Returns

return true if the computation is successful and false in case of failure.

---

The documentation for this class was generated from the following file:

• RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/IrpsWLRandomness.h