ScriptingTool#

class ansys.stk.core.stkobjects.astrogator.ScriptingTool#

Bases: IRuntimeTypeInfoProvider

Scripting Tool.

Overview#

Methods

`script_text`	Injects the script into the scripting tool.
`copy_to_clipboard`	Copy entire scripting tool to clipboard.
`paste_from_clipboard`	Replace entire scripting tool with scripting tool in clipboard.

Properties

`enable`	If true, the scripting tool is enabled.
`segment_properties`	Return the collection of the segment properties.
`calculation_objects`	Return the collection of the calculation objects.
`parameters`	Return the collection of parameters.
`language_type`	Get or set the scripting language being used.
`pre_iterate`	If true, the sequence will run once before executing the script.

from ansys.stk.core.stkobjects.astrogator import ScriptingTool

property ScriptingTool.enable: bool#: If true, the scripting tool is enabled.

property ScriptingTool.segment_properties: ScriptingSegmentCollection#: Return the collection of the segment properties.

property ScriptingTool.calculation_objects: ScriptingCalculationObjectCollection#: Return the collection of the calculation objects.

property ScriptingTool.parameters: ScriptingParameterCollection#: Return the collection of parameters.

property ScriptingTool.language_type: Language#: Get or set the scripting language being used.

property ScriptingTool.pre_iterate: bool#: If true, the sequence will run once before executing the script.

ScriptingTool.script_text(self, script: str) → None#

Injects the script into the scripting tool.

ScriptingTool.copy_to_clipboard(self) → None#

Copy entire scripting tool to clipboard.

ScriptingTool.paste_from_clipboard(self) → None#

Replace entire scripting tool with scripting tool in clipboard.