WindLabAPI::IrpsWLCumulativeProbabilityDistribution Class Reference

An abstract class representing a cumulative probability distribution. More...

#include <IrpsWLCumulativeProbabilityDistribution.h>

Public Member Functions
virtual bool	ComputeCPDValue (const WindLabSimulationData &Data, const double &x, double &dValue)=0
	Compute the cumulative probability distribution value for x.
virtual bool	ComputeCPDVectorX (const WindLabSimulationData &Data, vec &dVarVector, vec &dValVector)=0
	Compute the cumulative probability distribution for all increments of variable x.
virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.
virtual	~IrpsWLCumulativeProbabilityDistribution ()
	Virtual destructor for IrpsWLCumulativeProbabilityDistribution class.
Public Member Functions inherited from WindLabAPI::WindLabFeatureCumulativeProbabilityDistribution
virtual const char *	getViewProviderName () const
	WindLabFeatureCumulativeProbabilityDistribution (void)
	Constructor.
virtual	~WindLabFeatureCumulativeProbabilityDistribution ()
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::WindLabFeatureCumulativeProbabilityDistribution
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 cumulative probability distribution.

This is a pure virtual class (interface) that defines the interface for all cumulative probability distributions. A cumulative probability distribution provides a quantitative measure of the likelihood that the random phenomenon will fall below a certain threshold, helping to translate the stochastic nature of phenomenon into usable data for simulations. The cumulative probability distribution is used to describe the cumulative probability of the phenomenon value occurring within a specified range, offering valuable insights into the phenomenon behavior and enabling the generation of realistic phenomenon time series. Derived classes must implement all its methods.

Constructor & Destructor Documentation

~IrpsWLCumulativeProbabilityDistribution()

virtual WindLabAPI::IrpsWLCumulativeProbabilityDistribution::~IrpsWLCumulativeProbabilityDistribution ( )

virtual

Virtual destructor for IrpsWLCumulativeProbabilityDistribution class.

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

Member Function Documentation

ComputeCPDValue()

virtual bool WindLabAPI::IrpsWLCumulativeProbabilityDistribution::ComputeCPDValue ( const WindLabSimulationData & Data, const double & x, double & dValue )

pure virtual

Compute the cumulative probability distribution value for x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
x	a value for with the cumulative probability distribution is computed
dValue	a value to be updated. This is the computed value.

Returns

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

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

ComputeCPDVectorX()

virtual bool WindLabAPI::IrpsWLCumulativeProbabilityDistribution::ComputeCPDVectorX ( const WindLabSimulationData & Data, vec & dVarVector, vec & dValVector )

pure virtual

Compute the cumulative probability distribution for all increments of variable x.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dVarVector	a vector to be updated. It should contains all the variable x increments used to compute each value stored in dValVector.
dValVector	a vector to be updated. It should contain all the values computed for each variable x increment stored in dVarVector.

Returns

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

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

OnInitialSetting()

virtual bool WindLabAPI::IrpsWLCumulativeProbabilityDistribution::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/IrpsWLCumulativeProbabilityDistribution.h