ExecuteCommandResult

class ansys.stk.core.stkutil.ExecuteCommandResult

Collection of strings returned by the ExecuteCommand.

Overview

Methods

item	Get the element at the specified index (0-based).
range	Return the elements within the specified range.

Properties

count	Number of elements contained in the collection.
_new_enum	Return an object that can be used to iterate through all the strings in the collection.
is_succeeded	Indicate whether the object contains valid results.

Import detail

from ansys.stk.core.stkutil import ExecuteCommandResult

Property detail

property ExecuteCommandResult.count: int

Number of elements contained in the collection.

property ExecuteCommandResult._new_enum: EnumeratorProxy

Return an object that can be used to iterate through all the strings in the collection.

property ExecuteCommandResult.is_succeeded: bool

Indicate whether the object contains valid results.

Method detail

ExecuteCommandResult.item(self, index: int) → str

Get the element at the specified index (0-based).

Parameters:

index : int

Returns:

str

ExecuteCommandResult.range(self, start_index: int, stop_index: int) → list

Return the elements within the specified range.

Parameters:

start_index : int

stop_index : int

Returns:

list