ProfileScriptingTool

class ansys.stk.core.stkobjects.astrogator.ProfileScriptingTool

Bases: IProfile, IRuntimeTypeInfoProvider

The Scripting Tool profile.

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 will be used.
segment_properties	Return the collection of the segment properties.
calculation_objects	Return the collection of the calc objects.
parameters	Return the collection of parameters.
language_type	Get or set the scripting language being used.

Import detail

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

Property detail

property ProfileScriptingTool.enable: bool

If true, the scripting tool will be used.

property ProfileScriptingTool.segment_properties: ScriptingSegmentCollection

Return the collection of the segment properties.

property ProfileScriptingTool.calculation_objects: ScriptingCalculationObjectCollection

Return the collection of the calc objects.

property ProfileScriptingTool.parameters: ScriptingParameterCollection

Return the collection of parameters.

property ProfileScriptingTool.language_type: Language

Get or set the scripting language being used.

Method detail

ProfileScriptingTool.script_text(self, script: str) → None

Injects the script into the scripting tool.

Parameters:

script : str

Returns:

None

ProfileScriptingTool.copy_to_clipboard(self) → None

Copy entire scripting tool to clipboard.

Returns:

None

ProfileScriptingTool.paste_from_clipboard(self) → None

Replace entire scripting tool with scripting tool in clipboard.

Returns:

None