Structure

Table 6 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 the Swan construct.

This method is implemented by derived classes that correspond to a declaration at the module level (such as sensor, type, group, const, operator), or a module itself.

Returns:

str

Path within the owner and name of the Swan construct.

Raises:

ScadeOneException

If the method is not implemented for the current SwanItem type.

static set_owner(owner: SwanItem | IModel | None, children: SwanItem | Iterable[SwanItem] | None) → None

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

Parameters:

ownerSwanItem

Owner of the items.

childrenUnion[SwanItem, Iterable[SwanItem], None]

Items to set owner.

property at: Identifier | None

Memory constrained location.

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: IModel

Return model containing the Swan item.

property module: ModuleBase | None

Module containing the item.

Returns:

ModuleBase: module container, see ModuleBody and ModuleInterface or None if the object is itself a module.

property owner: SwanItem | IModel | None

Owner of current Swan construct.

property type: PathIdentifier | None

Structure type.

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

Bases: Expression

Group creation from structure: group_id group (expr) where group_id is the group type.

get_full_path() → str

Full path of the Swan construct.

This method is implemented by derived classes that correspond to a declaration at the module level (such as sensor, type, group, const, operator), or a module itself.

Returns:

str

Path within the owner and name of the Swan construct.

Raises:

ScadeOneException

If the method is not implemented for the current SwanItem type.

static set_owner(owner: SwanItem | IModel | None, children: SwanItem | Iterable[SwanItem] | None) → None

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

Parameters:

ownerSwanItem

Owner of the items.

childrenUnion[SwanItem, Iterable[SwanItem], None]

Items to set owner.

property at: Identifier | None

Memory constrained location.

property expr: Expression

Expression.

property group_id: 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: IModel

Return model containing the Swan item.

property module: ModuleBase | None

Module containing the item.

Returns:

ModuleBase: module container, see ModuleBody and ModuleInterface or None if the object is itself a module.

property owner: SwanItem | IModel | None

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 the Swan construct.

This method is implemented by derived classes that correspond to a declaration at the module level (such as sensor, type, group, const, operator), or a module itself.

Returns:

str

Path within the owner and name of the Swan construct.

Raises:

ScadeOneException

If the method is not implemented for the current SwanItem type.

static set_owner(owner: SwanItem | IModel | None, children: SwanItem | Iterable[SwanItem] | None) → None

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

Parameters:

ownerSwanItem

Owner of the items.

childrenUnion[SwanItem, Iterable[SwanItem], None]

Items to set owner.

property at: Identifier | None

Memory constrained location.

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: IModel

Return model containing the Swan item.

property module: ModuleBase | None

Module containing the item.

Returns:

ModuleBase: module container, see ModuleBody and ModuleInterface or None if the object is itself a module.

property owner: SwanItem | IModel | None

Owner of current Swan construct.