ScriptingProject

class ansys.sam.sysml2.classes.scripting_project.ScriptingProject

Bases: abc.ABC

Scripting project interface for users.

Overview

Abstract methods

get_id	Get the project ID.
get_name	Get the project name.
get_root	Get a list of root packages.
get_root_package	Get the root package.
find_element_by_id	Find an element by ID.
find_elements_by_name	Find all elements by name.
start_transactional_mode	Start a transactional mode for model edition.
stop_transactional_mode	Stop the current transaction.

Properties

root	Get a list of root packages.
name	Get the project name.
root_package	Get the root package.

Import detail

from ansys.sam.sysml2.classes.scripting_project import ScriptingProject

Property detail

property ScriptingProject.root: List[ansys.sam.sysml2.classes.sysml_element.SysMLElement]

Get a list of root packages.

property ScriptingProject.name: str

Get the project name.

property ScriptingProject.root_package: ansys.sam.sysml2.classes.sysml_element.SysMLElement

Get the root package.

Method detail

abstractmethod ScriptingProject.get_id() → str

Get the project ID.

abstractmethod ScriptingProject.get_name() → str

Get the project name.

abstractmethod ScriptingProject.get_root() → List[ansys.sam.sysml2.classes.sysml_element.SysMLElement]

Get a list of root packages.

abstractmethod ScriptingProject.get_root_package() → ansys.sam.sysml2.classes.sysml_element.SysMLElement

Get the root package.

abstractmethod ScriptingProject.find_element_by_id(element_id: str) → ansys.sam.sysml2.classes.sysml_element.SysMLElement

Find an element by ID.

Parameters:

element_idstr

Element ID.

Returns:

SysMLElement

Element retrieved.

abstractmethod ScriptingProject.find_elements_by_name(element_name: str) → List[ansys.sam.sysml2.classes.sysml_element.SysMLElement]

Find all elements by name.

Parameters:

element_namestr

Name of elements.

Returns:

List[SysMLElement]

List of elements retrieved.

abstractmethod ScriptingProject.start_transactional_mode()

Start a transactional mode for model edition.

This method will stop direct update for the model, and register all changes until you commit or stop the transactional mode.

Warning, all calculated modifications will not be applied, until the commit of all changes.

abstractmethod ScriptingProject.stop_transactional_mode()

Stop the current transaction.

This method will close the current transaction and commit all changes to the server.