RAModuleCollection

class ansys.rocky.app.ra_addins.RAModuleCollection(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper for the collection of module in a project.

This wrapper corresponds to the “Modules” item on the project’s data tree. Retrieve the RAModuleCollection from a RAStudy via:

module_collection = study.GetModuleCollection()

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetModuleNames	Get the names of the modules in project.
GetEnabledModules	Get the names of the enabled modules in project.
GetModule	Get a module given its name.

Import detail

from ansys.rocky.app.ra_addins import RAModuleCollection

Method detail

classmethod RAModuleCollection.GetWrappedClass() → type[rocky30.plugins.addins.model.addin_manager.AddinManager]

classmethod RAModuleCollection.GetClassName() → str

RAModuleCollection.GetModuleNames() → list[str]

Get the names of the modules in project.

RAModuleCollection.GetEnabledModules() → list[str]

Get the names of the enabled modules in project.

RAModuleCollection.GetModule(module_name: str) → RAModule

Get a module given its name.

Parameters:

module_name – The name of the module to get.