Structure#

Structure operations#
Operation	Class
{} (Structure constructor)	`StructConstructor`
.() (Structure destructor)	`StructDestructor`
.l (Projection)	`StructProjection`
_ with .l (Functional update)	See Functional update

class ansys.scadeone.core.swan.StructConstructor(group: Group, type: PathIdentifier | None = None)#

Bases: Expression

Structure expression, with optional type for cast to structure from a group: { group } [[ : path_id]].

get_full_path() → str#: Full path of Swan construct.

static set_owner(owner: Self, children: Self | Iterable[Self])#

Helper to set owner as the owner of each item in the Iterable items.

Parameters:

ownerSwanItem: Owner of the items.
childrenUnion[SwanItem, Iterable[SwanItem]]: Items to set owner.

property group: Group#: Group value

property is_protected: bool#: Tell if a construct item is syntactically protected with some markup and is stored as a string (without the markup).

property model: Model#: Return model containing the Swan item.

property module: ModuleBase#

Module containing the item.

Returns:: ModuleBase: module container, see ModuleBody and ModuleInterface

property owner: Self#: Owner of current Swan construct.

property type: PathIdentifier | None#: Structure type.

class ansys.scadeone.core.swan.StructDestructor(group: PathIdentifier, expr: Expression)#

Bases: Expression

Group creation: path_id group (expr).

get_full_path() → str#: Full path of Swan construct.

static set_owner(owner: Self, children: Self | Iterable[Self])#

Helper to set owner as the owner of each item in the Iterable items.

Parameters:

ownerSwanItem: Owner of the items.
childrenUnion[SwanItem, Iterable[SwanItem]]: Items to set owner.

property expr: Expression#: Expression.

property group: PathIdentifier#: Group type.

property is_protected: bool#: Tell if a construct item is syntactically protected with some markup and is stored as a string (without the markup).

property model: Model#: Return model containing the Swan item.

property module: ModuleBase#

Module containing the item.

Returns:: ModuleBase: module container, see ModuleBody and ModuleInterface

property owner: Self#: Owner of current Swan construct.

class ansys.scadeone.core.swan.StructProjection(expr: Expression, label: Identifier)#

Bases: Expression

Static structure field access: expr . label.

get_full_path() → str#: Full path of Swan construct.

static set_owner(owner: Self, children: Self | Iterable[Self])#

Helper to set owner as the owner of each item in the Iterable items.

Parameters:

ownerSwanItem: Owner of the items.
childrenUnion[SwanItem, Iterable[SwanItem]]: Items to set owner.

property expr: Expression#: Expression.

property is_protected: bool#: Tell if a construct item is syntactically protected with some markup and is stored as a string (without the markup).

property label: Identifier#: Field name.

property model: Model#: Return model containing the Swan item.

property module: ModuleBase#

Module containing the item.

Returns:: ModuleBase: module container, see ModuleBody and ModuleInterface

property owner: Self#: Owner of current Swan construct.