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

#include <IrpsWLTableTool.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	TableToolCompute (const WindLabSimulationData &Data, const mat &inputTable, mat &outputTable)=0
	Compute the kurtosis at a given location (simulation point) and for all time increments.

virtual	~IrpsWLTableTool ()
	Virtual destructor for IrpsWLTableTool class.

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

	WindLabFeatureTableTool (void)
	Constructor.

virtual	~WindLabFeatureTableTool ()

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::WindLabFeatureTableTool
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 table tool.

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

Constructor & Destructor Documentation

◆ ~IrpsWLTableTool()

virtual WindLabAPI::IrpsWLTableTool::~IrpsWLTableTool ( )

virtual

Virtual destructor for IrpsWLTableTool class.

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

Member Function Documentation

◆ OnInitialSetting()

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

◆ TableToolCompute()

virtual bool WindLabAPI::IrpsWLTableTool::TableToolCompute	(	const WindLabSimulationData &	Data,
		const mat &	inputTable,
		mat &	outputTable )

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 table to be manipulated, analyzed and processed.
outputMatrix	a matrix to be updated. This is the result table.

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

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

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

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