CalculationToolScalarPlugin

class ansys.stk.core.analysis_workbench.CalculationToolScalarPlugin

Bases: ICalculationToolScalar, IAnalysisWorkbenchComponent

Use a scalar calculation plugin.

Overview

Methods

reset	Reset the plugin.
set_property	Set the plugin properties. This method throws an exception if the specified property does not exist, an invalid value was specified or the specified property is read-only.
get_property	Read a value of the specified plugin property. This method throws an exception if the property does not exist.

Properties

prog_id	A programmatic ID associated with the component.
display_name	The plugin’s Display Name associated with the COM plugin.
available_properties	An array of names of the properties that can be used to configure the plugin.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarPlugin

Property detail

property CalculationToolScalarPlugin.prog_id: str

A programmatic ID associated with the component.

property CalculationToolScalarPlugin.display_name: str

The plugin’s Display Name associated with the COM plugin.

property CalculationToolScalarPlugin.available_properties: list

An array of names of the properties that can be used to configure the plugin.

Method detail

CalculationToolScalarPlugin.reset(self) → None

Reset the plugin.

Returns:

None

CalculationToolScalarPlugin.set_property(self, name: str, value: str) → None

Set the plugin properties. This method throws an exception if the specified property does not exist, an invalid value was specified or the specified property is read-only.

Parameters:

name : str

value : str

Returns:

None

CalculationToolScalarPlugin.get_property(self, name: str) → str

Read a value of the specified plugin property. This method throws an exception if the property does not exist.

Parameters:

name : str

Returns:

str