VectorGeometryToolPointPlugin

class ansys.stk.core.analysis_workbench.VectorGeometryToolPointPlugin

Bases: IAnalysisWorkbenchComponent, IAnalysisWorkbenchComponentTimeProperties, IVectorGeometryToolPoint

A VGT point plugin.

Overview

Methods

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

Properties

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

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolPointPlugin

Property detail

property VectorGeometryToolPointPlugin.available_properties: list

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

property VectorGeometryToolPointPlugin.display_name: str

Plugin’s Display Name associated with the COM plugin.

property VectorGeometryToolPointPlugin.prog_id: str

A programmatic ID associated with the component.

Method detail

VectorGeometryToolPointPlugin.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

VectorGeometryToolPointPlugin.reset(self) → None

Reset the plugin.

Returns:

None

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

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

Parameters:

name : str

value : str

Returns:

None