Scalar.__init__
Scalar.__init__ |
Purpose
The constructor.
Synopsis
__init__(self, default: Union[str, bool, int, float] = None, dtype: Type[xpressinsight.BasicType] = None, alias: str = '', format: str = '', hidden: xpressinsight.Hidden = Hidden.FALSE, manage: xpressinsight.Manage = Manage.INPUT, read_only: bool = False, transform_labels_entity: str = '', update_after_execution: bool = False)
Arguments
|
default
|
The default value.
|
|
dtype
|
The data-type.
|
|
alias
|
Used to provide an alternative name for an entity in the UI. The value is used in place of the entity name where appropriate in the UI.
|
|
format
|
The formatting string used for displaying numeric values.
|
|
hidden
|
Indicates whether the UI should hide the entity where appropriate.
|
|
manage
|
How and whether Insight handles an entity. Defines how the system manages the entity data.
|
|
read_only
|
Whether an entity is readonly. Specifies that the value(s) of the entity cannot be modified. See also
hidden.
|
|
transform_labels_entity
|
An entity in the schema to be used as a labels entity. The value is the name of the entity. The type of the index set of the labels entity much match the data type of this entity. The data type of the labels entity can be any primitive type.
|
|
update_after_execution
|
Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution. If
True the value of the entity is updated to correspond with the model entity after execution.
|