Expressions#

Expressions are implemented with classes that have Expression as top-level class. Protected expressions are implemented as ProtectedExpr.

Groups as defined in Group are also Expression.

../../../_images/protected_expr.svg
class ansys.scadeone.core.swan.Expression#

Bases: SwanItem

Base class for expressions.

get_full_path() → str#

Full path of Swan construct.

static set_owner(owner: SwanItem | IProject | None, children: SwanItem | Iterable[SwanItem]) → 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]]

Items to set owner.

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 | 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 | IProject | None#

Owner of current Swan construct.

class ansys.scadeone.core.swan.ProtectedExpr(data: str, markup: str | None = 'syntax')#

Bases: Expression, ProtectedItem

Protected expression, i.e., saved as string if syntactically incorrect.

get_full_path() → str#

Full path of Swan construct.

has_markup(markup: str) → bool#

Check if protected data has the specified markup.

Parameters:
markupstr

String markup.

Returns:
result: bool

True when instance markup is same as parameter.

static set_owner(owner: SwanItem | IProject | None, children: SwanItem | Iterable[SwanItem]) → 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]]

Items to set owner.

property data: str#

Protected data between markups.

Returns:
str

Protected data.

property is_protected: bool#

Tell if item is syntactically protected and provided as a string.

property markup: str#

Protection markup.

Returns:
str

Markup string.

property model: Model#

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 | IProject | None#

Owner of current Swan construct.

Show Source