VectorGeometryToolAxesReference

class ansys.stk.core.analysis_workbench.VectorGeometryToolAxesReference

Bases: IAnalysisWorkbenchComponentReference

Represents a reference to a VGT axes.

Overview

Methods

get_axes	Return the actual axes 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.
set_axes	Set a new axes.
set_path	Set a new axes.

Import detail

from ansys.stk.core.analysis_workbench import VectorGeometryToolAxesReference

Method detail

VectorGeometryToolAxesReference.get_axes(self) → IVectorGeometryToolAxes

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

Returns:

IVectorGeometryToolAxes

VectorGeometryToolAxesReference.has_cyclic_dependency(self, axes: IVectorGeometryToolAxes) → bool

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

Parameters:

axes : IVectorGeometryToolAxes

Returns:

bool

VectorGeometryToolAxesReference.set_axes(self, axes: IVectorGeometryToolAxes) → None

Set a new axes.

Parameters:

axes : IVectorGeometryToolAxes

Returns:

None

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

Set a new axes.

Parameters:

path : str

Returns:

None