IAnalysisWorkbenchComponent

class ansys.stk.core.analysis_workbench.IAnalysisWorkbenchComponent

A base interface implemented by all VGT components. The methods and properties of the interface provide type information about the VGT component.

Overview

Methods

anonymous_duplicate	Create an anonymous copy of the instance of a VGT component. The new component is not registered and will not be persisted nor restored when a scenario is saved or loaded.
depends_on	Test if the instance depends on another component.
duplicate	Create a copy of the instance of a VGT component. The new component is automatically registered and will be persisted or restored when a scenario is saved or loaded.
export	Export the component to a file.
rename	Rename the component.

Properties

category	Allow the user to access or change the component category (Folder).
component_type	Return the component kind.
context	Return the context object associated with the instance. The returned object is either an instance of AnalysisWorkbenchComponentInstance or AnalysisWorkbenchComponentTemplate interface.
description	Return the component description.
embedded_components	Return a collection of embedded components.
is_duplicable	Return whether the VGT component can be duplicated.
is_read_only	Return whether the component is modifiable.
is_ready	Return whether the component is ready. The component is ready if it’s been fully initialized.
is_valid	Return whether the component is valid.
name	Return the component name.
path	Return the component’s fully qualified path (ie. CentralBody/Earth Body, etc.).
qualified_path	An STK-conformant path to the VGT component that can be used to visualize the VGT components in 3D (i.e. CentralBody/Earth Body Vector, etc.).
type_information	Return the component type information.

Import detail

from ansys.stk.core.analysis_workbench import IAnalysisWorkbenchComponent

Property detail

property IAnalysisWorkbenchComponent.category: str

Allow the user to access or change the component category (Folder).

property IAnalysisWorkbenchComponent.component_type: VectorGeometryToolComponentType

Return the component kind.

property IAnalysisWorkbenchComponent.context: IAnalysisWorkbenchComponentContext

Return the context object associated with the instance. The returned object is either an instance of AnalysisWorkbenchComponentInstance or AnalysisWorkbenchComponentTemplate interface.

property IAnalysisWorkbenchComponent.description: str

Return the component description.

property IAnalysisWorkbenchComponent.embedded_components: AnalysisWorkbenchComponentCollection

Return a collection of embedded components.

property IAnalysisWorkbenchComponent.is_duplicable: bool

Return whether the VGT component can be duplicated.

property IAnalysisWorkbenchComponent.is_read_only: bool

Return whether the component is modifiable.

property IAnalysisWorkbenchComponent.is_ready: bool

Return whether the component is ready. The component is ready if it’s been fully initialized.

property IAnalysisWorkbenchComponent.is_valid: bool

Return whether the component is valid.

property IAnalysisWorkbenchComponent.name: str

Return the component name.

property IAnalysisWorkbenchComponent.path: str

Return the component’s fully qualified path (ie. CentralBody/Earth Body, etc.).

property IAnalysisWorkbenchComponent.qualified_path: str

An STK-conformant path to the VGT component that can be used to visualize the VGT components in 3D (i.e. CentralBody/Earth Body Vector, etc.).

property IAnalysisWorkbenchComponent.type_information: AnalysisWorkbenchComponentTypeInformation

Return the component type information.

Method detail

IAnalysisWorkbenchComponent.anonymous_duplicate(self) → IAnalysisWorkbenchComponent

Create an anonymous copy of the instance of a VGT component. The new component is not registered and will not be persisted nor restored when a scenario is saved or loaded.

Returns:

IAnalysisWorkbenchComponent

IAnalysisWorkbenchComponent.depends_on(self, component: IAnalysisWorkbenchComponent) → bool

Test if the instance depends on another component.

Parameters:

component : IAnalysisWorkbenchComponent

Returns:

bool

IAnalysisWorkbenchComponent.duplicate(self, new_name: str, description: str) → IAnalysisWorkbenchComponent

Create a copy of the instance of a VGT component. The new component is automatically registered and will be persisted or restored when a scenario is saved or loaded.

Parameters:

new_name : str

description : str

Returns:

IAnalysisWorkbenchComponent

IAnalysisWorkbenchComponent.export(self, filename: str, comments: str) → None

Export the component to a file.

Parameters:

filename : str

comments : str

Returns:

None

IAnalysisWorkbenchComponent.rename(self, new_name: str) → None

Rename the component.

Parameters:

new_name : str

Returns:

None