Operator sections

Scope contains scope sections which define variables, equations, diagrams, formal properties and emissions.

The Scope class is used to define the scope and contains a list of ScopeSection. It derives from the HasPragma class as a scope can have pragmas for the layout of blocks defined by:py:class:ActivateIf and ActivateWhen constructs.

class ansys.scadeone.core.swan.Scope(sections: List[ScopeSection] | None = None, pragmas: List[Pragma] | None = None)

Bases: HasPragma

Scope definition:

data_def ::= scope

scope ::= { {{scope_section}} }

get_declaration(name: str) → Declaration | None

Returns the type, global, operator or variable declaration searching by namespace.

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.

property pragmas: List[Pragma]

List of pragmas.

property sections: List[ScopeSection]

Scope sections.

class ansys.scadeone.core.swan.ScopeSection

Bases: SwanItem

Base class for scopes.

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

class ansys.scadeone.core.swan.ProtectedSection(data: str)

Bases: ScopeSection, ProtectedItem

Protected section, meaning a syntactically incorrect section construct.

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.

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

True when section is given from {text%…%text} markup.

property markup: str

Protection markup.

Returns:

str

Markup string.

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.