hpcflow.sdk.core.element.ElementParameter#

class hpcflow.sdk.core.element.ElementParameter(task, path, parent, element)#

Bases: object

A parameter to an Element.

Parameters:

task (WorkflowTask) – The task that this is part of.
path (str) – The path to this parameter.
parent (Element | ElementAction | ElementActionRun | Parameters) – The entity that owns this parameter.
element (Element) – The element that this is a parameter of.

Methods

Get the size of the parameter.

Attributes

`data_idx`	The data indices associated with this parameter.
`data_idx_is_set`	The associated data indices for which this is set.
`is_set`	Whether this parameter is set.
`value`	The value of this parameter.
`app`	Application context.
`task`	The task that this is part of.
`path`	The path to this parameter.
`parent`	The entity that owns this parameter.
`element`	The element that this is a parameter of.

app: ClassVar[BaseApp]#: Application context.

property data_idx: DataIndex#: The data indices associated with this parameter.

property data_idx_is_set: Mapping[str, bool]#: The associated data indices for which this is set.

element: Element | ElementIteration#: The element that this is a parameter of.

get_size(**store_kwargs)#: Get the size of the parameter.

property is_set: bool#: Whether this parameter is set.

parent: Element | ElementAction | ElementActionRun | ElementIteration#: The entity that owns this parameter.

path: str#: The path to this parameter.

task: WorkflowTask#: The task that this is part of.

property value: Any#: The value of this parameter.