An abstract class representing a matrix tool. More...

#include <IrpsWLMatrixTool.h>

Public Member Functions
virtual bool	MatrixToolCompute (const WindLabSimulationData &Data, const mat &inputMatrix, mat &outputMatrix)=0
	Compute the kurtosis at a given location (simulation point) and for all time increments.

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

virtual	~IrpsWLMatrixTool ()
	Virtual destructor for IrpsWLMatrixTool class.

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

	WindLabFeatureMatrixTool (void)
	Constructor.

virtual	~WindLabFeatureMatrixTool ()

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::WindLabFeatureMatrixTool
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 matrix tool.

This is a pure virtual class (interface) that defines the interface for all matrix tools. A matrix tool is a feature (tool) for manipulation data presentated in the form of Alphaplot matrix.
The WindLab framework run this tool on the active alphaplot matrix. Without have an active alphaplot matrix as the active window, the user will not have access to the command that run this tool. Note that, internally the alphaplot matrix is first converted into Eigen matrix and is passed to this tool. If you call this tool directly from your code, you don't any alphaplot matrix to be active.
Derived classes must implement all its methods.

Constructor & Destructor Documentation

◆ ~IrpsWLMatrixTool()

virtual WindLabAPI::IrpsWLMatrixTool::~IrpsWLMatrixTool ( )

virtual

Virtual destructor for IrpsWLMatrixTool class.

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

Member Function Documentation

◆ MatrixToolCompute()

virtual bool WindLabAPI::IrpsWLMatrixTool::MatrixToolCompute	(	const WindLabSimulationData &	Data,
		const mat &	inputMatrix,
		mat &	outputMatrix )

pure virtual

Compute the kurtosis at a given location (simulation point) and for all time increments.

Parameters

Data	the simulation data containing all the simulation parameters input by the user.
inputMatrix	a matrix to be updated. This the matrix to be manipulated, analyzed and processed.
outputMatrix	a matrix to be updated. This is the result matrix.

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

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

◆ OnInitialSetting()

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

pure virtual

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