VectorGeometryToolAngleReference

class ansys.stk.core.analysis_workbench.VectorGeometryToolAngleReference

Bases: IAnalysisWorkbenchComponentReference

Represents a reference to a VGT angle.

Overview

Methods

set_path	Set a new angle.
set_angle	Set a new angle.
get_angle	Return the actual angle 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 VectorGeometryToolAngleReference

Method detail

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

Set a new angle.

Parameters:

path : str

Returns:

None

VectorGeometryToolAngleReference.set_angle(self, angle: IVectorGeometryToolAngle) → None

Set a new angle.

Parameters:

angle : IVectorGeometryToolAngle

Returns:

None

VectorGeometryToolAngleReference.get_angle(self) → IVectorGeometryToolAngle

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

Returns:

IVectorGeometryToolAngle

VectorGeometryToolAngleReference.has_cyclic_dependency(self, angle: IVectorGeometryToolAngle) → bool

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

Parameters:

angle : IVectorGeometryToolAngle

Returns:

bool