Equations

Equations are grouped in a let section.

Fig. 7 Equation class diagram

class ansys.scadeone.core.swan.LetSection(equations: List[Equation])

Bases: ScopeSection

Implements:

let {{equation ;}} section.

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 equations: List[Equation]

List of equation in let.

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_text: bool

True when section is given from {text%…%text} 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 pragmas: List[Pragma]

Pragmas associated to this scope section.

Equation with expression

Equations have a left-hand side (LHS), the flows that are defined by the equation and the equation expression.

class ansys.scadeone.core.swan.Equation

Bases: SwanItem

Base class for equations.

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 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.EquationLHS(lhs_items: List[LHSItem], is_partial_lhs: bool = False)

Bases: SwanItem

Equation left-hand side part:

lhs ::= ( ) | lhs_item {{ , lhs_item }} [[ , .. ]]

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 is_partial_lhs: bool

True when lhs list is partial (syntax: final ‘..’ not in the list.

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 lhs_items: List[LHSItem]

Return left-hand side list.

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.LHSItem(id: Identifier | None = None)

Bases: SwanItem

Defines an item on the left-hand side of an equation, an ID, or underscore ‘_’.

Parameters:

idIdentifier (optional)

Identifier or None for underscore value.

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

Returns id value or None.

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_underscore: bool

True when LHSItem is ‘_’.

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.ExprEquation(lhs: EquationLHS, expr: Expression, luid: Luid | None = None)

Bases: Equation

Flows definition using an expression:

equation ::= lhs [luid] = expr

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 expr: Expression

Equation 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 lhs: EquationLHS

Left-hand side of the equation.

property luid: Luid | None

Equation LUID.

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.

Equation defined by cases

class ansys.scadeone.core.swan.DefByCase(lhs: EquationLHS | None = None, lunum: Lunum | None = None, luid: Luid | None = None)

Bases: Equation, ABC

Base class for state machine and active if/when equations.

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

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

property lhs: EquationLHS | None

Left-hand side of the equation, may be None.

property luid: Luid | None

Return luid or None if no luid.

property lunum: Lunum | None

Return lunum or None if no lunum.

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 pragmas: List[Pragma]

Pragmas associated to this Def by case.