IComponentInfo

class ansys.stk.core.stkobjects.IComponentInfo

Interface for a component.

Overview

Methods

is_read_only	Return true if the component is read-only.
export	Export the component with default component name as file name and component type as file extension to the scenario directory.
export_with_filename_path	Export the component with specified file name and location.

Properties

name	Get or set the component name.
user_comment	Get or set the user comment for this component.
description	Get the description for this component.

Import detail

from ansys.stk.core.stkobjects import IComponentInfo

Property detail

property IComponentInfo.name: str

Get or set the component name.

property IComponentInfo.user_comment: str

Get or set the user comment for this component.

property IComponentInfo.description: str

Get the description for this component.

Method detail

IComponentInfo.is_read_only(self) → bool

Return true if the component is read-only.

Returns:

bool

IComponentInfo.export(self) → None

Export the component with default component name as file name and component type as file extension to the scenario directory.

Returns:

None

IComponentInfo.export_with_filename_path(self, filename_path: str) → None

Export the component with specified file name and location.

Parameters:

filename_path : str

Returns:

None