VectorGeometryToolPointReference

class ansys.stk.core.analysis_workbench.VectorGeometryToolPointReference

Bases: IAnalysisWorkbenchComponentReference

Represents a reference to a VGT point.

Overview

Methods

set_path	Set a new point.
set_point	Set a new point.
get_point	Return the actual point object behind the reference. Use IAnalysisWorkbenchComponent.IsValid to test the validity of the returned object.
has_cyclic_dependency	Test whether the input component and the target component form a cyclic dependency.

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolPointReference

Method detail

VectorGeometryToolPointReference.set_path(self, path: str) → None

Set a new point.

Parameters:

path : str

Returns:

None

VectorGeometryToolPointReference.set_point(self, point: IVectorGeometryToolPoint) → None

Set a new point.

Parameters:

point : IVectorGeometryToolPoint

Returns:

None

VectorGeometryToolPointReference.get_point(self) → IVectorGeometryToolPoint

Return the actual point object behind the reference. Use IAnalysisWorkbenchComponent.IsValid to test the validity of the returned object.

Returns:

IVectorGeometryToolPoint

VectorGeometryToolPointReference.has_cyclic_dependency(self, point: IVectorGeometryToolPoint) → bool

Test whether the input component and the target component form a cyclic dependency.

Parameters:

point : IVectorGeometryToolPoint

Returns:

bool