VectorGeometryToolSystemReference

class ansys.stk.core.analysis_workbench.VectorGeometryToolSystemReference

Bases: IAnalysisWorkbenchComponentReference

Represents a System reference.

Overview

Methods

set_path	Set a new system.
set_system	Set a new system.
get_system	Return the actual system 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 VectorGeometryToolSystemReference

Method detail

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

Set a new system.

Parameters:

path : str

Returns:

None

VectorGeometryToolSystemReference.set_system(self, system: IVectorGeometryToolSystem) → None

Set a new system.

Parameters:

system : IVectorGeometryToolSystem

Returns:

None

VectorGeometryToolSystemReference.get_system(self) → IVectorGeometryToolSystem

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

Returns:

IVectorGeometryToolSystem

VectorGeometryToolSystemReference.has_cyclic_dependency(self, system: IVectorGeometryToolSystem) → bool

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

Parameters:

system : IVectorGeometryToolSystem

Returns:

bool