Identifiers and atoms#

Identifiers#

class ansys.scadeone.core.swan.PathIdExpr(path_id: PathIdentifier)#

Bases: Expression

ansys.scadeone.core.swan.PathIdentifier expression.

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 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 path_id: PathIdentifier#

The identifier expression.

class ansys.scadeone.core.swan.PortExpr(lunum: Luid | None = None, luid: Luid | None = None, is_self: bool | None = False)#

Bases: Expression

Port information.

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 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.LabelOrIndex(value: Identifier | Expression)#

Bases: Expression

Stores an index as:

• a label ansys.scadeone.swan.Identifier or,

• an expression ansys.scadeone.swan.Expression.

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 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 value: Identifier | Expression#

Return the index (expression or label).

class ansys.scadeone.core.swan.LastExpr(id: Identifier)#

Bases: Expression

Last expression.

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 id: Identifier#

Identifier.

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.

Literal#

class ansys.scadeone.core.swan.Literal(value: str)#

Bases: Expression

Class for char, numeric, and Boolean expression.

Boolean value is stored as ‘true’ or ‘false’.

Char value is a ascii char with its value between simple quotes (ex: ‘a’) or an hexadecimal value.

Numeric value is INTEGER, TYPED_INTEGER, FLOAT, TYPED_FLOAT (see language grammar definition and SwanRE class).

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 is_bool: bool#

Return true when LiteralExpr is a Boolean.

property is_char: bool#

Return true when LiteralExpr is a char.

property is_float#

Return true when LiteralExpr is a float.

property is_integer#

Return true when LiteralExpr is an integer.

property is_numeric: bool#

Return true when LiteralExpr is a numeric.

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 is_true: bool#

Return true when LiteralExpr is true.

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 value: str#

Literal expression.

class ansys.scadeone.core.swan.LiteralKind(value)#

Bases: Enum

Literal kind enumeration.

Bool = 1#

Boolean literal

Char = 2#

Char literal

Error = 4#

Erroneous literal

Numeric = 3#

Numeric literal (integer or float, with/without size)

Patterns#

Patterns are used by CaseExpr and ActivateWhen classes for the case pattern of and activate when constructs.

class ansys.scadeone.core.swan.Pattern#

Bases: SwanItem

Base class for patterns.

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 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.PathIdPattern(path_id: PathIdentifier)#

Bases: Pattern

Simple pattern: pattern ::= 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 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 path_id: PathIdentifier#

The path_id of pattern.

class ansys.scadeone.core.swan.VariantPattern(path_id: PathIdentifier, captured: Identifier | None = None, underscore: bool | None = False)#

Bases: Pattern

Variant pattern:

pattern ::=

• path_id _: has_underscore is True

• path_id { } has_underscore is False, has_capture is False

• path_id { Id } : has_capture is True

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 captured: Identifier | None#

The variant pattern captured tag.

property empty_capture: bool#

The variant pattern as an empty {} capture.

property has_capture: bool#

The variant pattern has a captured tag.

property has_underscore: bool#

Variant part is ‘_’.

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 path_id: PathIdentifier#

The path_id of variant pattern.

property underscore: bool | None#

Underscore as bool or None.

class ansys.scadeone.core.swan.CharPattern(value: str)#

Bases: Pattern

Pattern: pattern ::= CHAR.

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 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.BoolPattern(value: bool)#

Bases: Pattern

Pattern: pattern ::= true | false.

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 is_protected: bool#

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

property is_true: bool#

Return True when pattern is true, else False.

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 value: bool#

Return value as a bool value

class ansys.scadeone.core.swan.IntPattern(value: str, is_minus: bool | None = False)#

Bases: Pattern

Pattern: pattern ::= [-] INTEGER | [-] TYPED_INTEGER.

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 as_int: int#

Return value as an integer.

property is_minus: bool#

Return True when has sign minus.

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 value: str#

Return value as a string, without sign.

class ansys.scadeone.core.swan.UnderscorePattern#

Bases: Pattern

Pattern: pattern ::= _.

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 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.DefaultPattern#

Bases: Pattern

Pattern: pattern ::= default.

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 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.ProtectedPattern(data: str)#

Bases: Pattern, ProtectedItem

Protected pattern 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: 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 data: str#

Protected data between markups.

Returns:

str

Protected data.

property is_protected#

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#

Module containing the item.

Returns:

ModuleBase: module container, see ModuleBody and ModuleInterface

property owner: Self#

Owner of current Swan construct.