ScriptingParameter

class ansys.stk.core.stkobjects.astrogator.ScriptingParameter

Bases: IRuntimeTypeInfoProvider

Scripting Parameter.

Overview

Properties

name	Get or set the parameter name.
parameter_value	Get or set the parameter value. Set in Object Model unit preference for selected dimension.
unit	Get or set the parameter’s unit that is used to represent ParamValue during the scripting tool script execution. ParamValue is set in Object Model unit preference for selected dimension and not this unit. As with other units configurable in the desktop environment for STK, this unit is separate (and may differ) from the Object Model unit preference.
type	Get or set the parameter’s type.
inherit_value	If true, parameter value will be inherited from previous profile’s value.
user_comment	Get or set the parameter’s comment.
dimension	Get or set the parameter’s dimension.
enumeration_choices	Get the collection of enumerations to use when parameter type is eVAScriptingParameterTypeEnumeration.
use_min_value	If true, a minimum value will be enforced for the parameter value.
min_value	Get or set the minimum value permitted for the parameter value.
use_max_value	If true, a maximum value will be enforced for the parameter value.
max_value	Get or set the maximum value permitted for the parameter value.

Import detail

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

Property detail

property ScriptingParameter.name: str

Get or set the parameter name.

property ScriptingParameter.parameter_value: Any

Get or set the parameter value. Set in Object Model unit preference for selected dimension.

property ScriptingParameter.unit: str

Get or set the parameter’s unit that is used to represent ParamValue during the scripting tool script execution. ParamValue is set in Object Model unit preference for selected dimension and not this unit. As with other units configurable in the desktop environment for STK, this unit is separate (and may differ) from the Object Model unit preference.

property ScriptingParameter.type: ScriptingParameterType

Get or set the parameter’s type.

property ScriptingParameter.inherit_value: bool

If true, parameter value will be inherited from previous profile’s value.

property ScriptingParameter.user_comment: str

Get or set the parameter’s comment.

property ScriptingParameter.dimension: str

Get or set the parameter’s dimension.

property ScriptingParameter.enumeration_choices: ScriptingParameterEnumerationChoiceCollection

Get the collection of enumerations to use when parameter type is eVAScriptingParameterTypeEnumeration.

property ScriptingParameter.use_min_value: bool

If true, a minimum value will be enforced for the parameter value.

property ScriptingParameter.min_value: Any

Get or set the minimum value permitted for the parameter value.

property ScriptingParameter.use_max_value: bool

If true, a maximum value will be enforced for the parameter value.

property ScriptingParameter.max_value: Any

Get or set the maximum value permitted for the parameter value.