An abstract class representing a user defined object. More...

#include <IrpsWLUserDefinedRPSObject.h>

Public Member Functions
virtual bool	OnInitialSetting (const WindLabSimulationData &Data)=0
	Allows to do any initial taks before any of the other methods is called.

virtual bool	UserDefinedRPSObjectCompute (const WindLabSimulationData &Data, mat &dresult)=0
	Run the user defined computation tool.

virtual	~IrpsWLUserDefinedRPSObject ()
	Virtual destructor for IrpsWLUserDefinedRPSObject class.

Public Member Functions inherited from WindLabAPI::WindLabFeatureUserDefinedRPSObject
virtual const char *	getViewProviderName () const

	WindLabFeatureUserDefinedRPSObject (void)
	Constructor.

virtual	~WindLabFeatureUserDefinedRPSObject ()

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::WindLabFeatureUserDefinedRPSObject
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 user defined object.

This is a pure virtual class (interface) that defines the interface for all user defined objects. This class allow to develop any kind of tool for the simulation of random wind velocity.
Derived classes must implement all its methods.

Constructor & Destructor Documentation

◆ ~IrpsWLUserDefinedRPSObject()

virtual WindLabAPI::IrpsWLUserDefinedRPSObject::~IrpsWLUserDefinedRPSObject ( )

virtual

Virtual destructor for IrpsWLUserDefinedRPSObject class.

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

Member Function Documentation

◆ OnInitialSetting()

virtual bool WindLabAPI::IrpsWLUserDefinedRPSObject::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.

◆ UserDefinedRPSObjectCompute()

virtual bool WindLabAPI::IrpsWLUserDefinedRPSObject::UserDefinedRPSObjectCompute	(	const WindLabSimulationData &	Data,
		mat &	dresult )

pure virtual

Run the user defined computation tool.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
dresult	a matrix to be updated. This is the computation result.

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

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

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

RPS/LabRPS/LabRPS_KOFFI/src/Mod/WindLabAPI/App/IrpsWLUserDefinedRPSObject.h