`Project`#

class ansys.sam.sysml2.classes.project.Project#

Bases: abc.ABC

Provides the project interface for users.

Overview#

Abstract methods

`get_id`	Get the project ID.
`get_name`	Get the project name.
`get_root_package`	Get the first package owned by the root Namespace.
`get_root_packages`	Get the packages owned by the root Namespace.
`get_libraries_packages`	Get the libraries packages.
`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

`id`	Get the project ID.
`name`	Get the project name.

Import detail#

from ansys.sam.sysml2.classes.project import Project

Property detail#

property Project.id: str#: Get the project ID.

property Project.name: str#: Get the project name.

Method detail#

abstractmethod Project.get_id() → str#: Get the project ID.

abstractmethod Project.get_name() → str#: Get the project name.

abstractmethod Project.get_root_package() → ansys.sam.sysml2.meta_model.package.Package#: Get the first package owned by the root Namespace.

abstractmethod Project.get_root_packages() → list[ansys.sam.sysml2.meta_model.package.Package]#: Get the packages owned by the root Namespace.

abstractmethod Project.get_libraries_packages() → list[ansys.sam.sysml2.meta_model.package.Package]#: Get the libraries packages.

abstractmethod Project.find_element_by_id(element_id: str) → ansys.sam.sysml2.meta_model.element.Element#

Find an element by ID.

Parameters:

element_idstr: Element ID.

Returns:

Element: Element retrieved.

abstractmethod Project.find_elements_by_name(element_name: str) → List[ansys.sam.sysml2.meta_model.element.Element]#

Find all elements by name.

Parameters:

element_namestr: Name of elements.

Returns:

List[Element]: The list of elements retrieved

abstractmethod Project.start_transactional_mode()#

Start a transactional mode for model edition.

Direct model updates are suspended and every change is registered until the transaction is committed or stopped. Calculated modifications are applied only once all changes are committed.

abstractmethod Project.stop_transactional_mode()#

Stop the current transaction.

Close the current transaction and commit all changes to the server.