## On this page

  

 

 # RAModule

 Last update: 17.07.2025 

<a id="generated.RAModule"></a>

### *class* RAModule

Rocky PrePost Scripting wrapper for an individual module in a project, below the “Modules” item. Retrieve individual module from the [`RAModuleCollection`](RAModuleCollection.md#generated.RAModuleCollection) via:

```python
module_collection = study.GetModuleCollection()
module = module_collection.GetModule('Module Name')

```

**Methods:**

NameDescription[`DisableModule`](#generated.RAModule.DisableModule)()Disable the module.[`EnableModule`](#generated.RAModule.EnableModule)()Enable the module.[`GetModuleProperties`](#generated.RAModule.GetModuleProperties)()Get the names of the module properties.[`GetModuleProperty`](#generated.RAModule.GetModuleProperty)(property\_name\[, unit\])Get the value of a module property.[`GetOutputObject`](#generated.RAModule.GetOutputObject)()Get the API object that represents this module's unique simulation results, if it exists.[`GetValidOptionsForModuleProperty`](#generated.RAModule.GetValidOptionsForModuleProperty)(property\_name)Get all valid options only for properties that have a list of possible options.[`IsModuleEnabled`](#generated.RAModule.IsModuleEnabled)()Check if the module is enabled.[`SetModuleEnabled`](#generated.RAModule.SetModuleEnabled)(enabled)Enable or disable the module.[`SetModuleProperty`](#generated.RAModule.SetModuleProperty)(property\_name, value\[, unit\])Set the value of a module property.<a id="generated.RAModule.DisableModule"></a>

#### DisableModule()

Disable the module.

<a id="generated.RAModule.EnableModule"></a>

#### EnableModule()

Enable the module.

<a id="generated.RAModule.GetModuleProperties"></a>

#### GetModuleProperties()

Get the names of the module properties.

- **Return type:**tuple(ModulePropertyIdentifier)

<a id="generated.RAModule.GetModuleProperty"></a>

#### GetModuleProperty(property\_name: str | ra\_addins.ModulePropertyIdentifier, unit: str | None = None)

Get the value of a module property.

- **Parameters:**
    - **property\_name** (*Union* \*\[\**str* *,* *ModulePropertyIdentifier* *\]*) – The name of the module property to get.
    - **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, the returned value will be in the unit that was set before (via SetModuleProperty()).
- **Return type:**float, bool, str or [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList)
- **Returns:**
    - For basic module properties like numbers and booleans, the returned value is a basic Python type (float, bool, or string)
    - For input files, the returned value is the string of the full path to the file
    - For properties that are lists of other properties, the returned value is a : [`RAModulePropertyList`](RAModulePropertyList.md#generated.RAModulePropertyList).

<a id="generated.RAModule.GetOutputObject"></a>

#### GetOutputObject()

Get the API object that represents this module’s unique simulation results, if it exists.

Note that only modules that declare that they generate “unique” results (as opposed to new properties/curves on existing items) will have an output object.

<a id="generated.RAModule.GetValidOptionsForModuleProperty"></a>

#### GetValidOptionsForModuleProperty(property\_name)

Get all valid options only for properties that have a list of possible options.

- **Parameters:****property\_name** (*str*) – The name of the module property.
- **Return type:**List\[str\]

<a id="generated.RAModule.IsModuleEnabled"></a>

#### IsModuleEnabled()

Check if the module is enabled.

- **Return type:**bool

<a id="generated.RAModule.SetModuleEnabled"></a>

#### SetModuleEnabled(enabled)

Enable or disable the module.

- **Parameters:****enabled** (*bool*) – Whether the module should be enabled (True) or disabled (False).

<a id="generated.RAModule.SetModuleProperty"></a>

#### SetModuleProperty(property\_name: str | ra\_addins.ModulePropertyIdentifier, value: float | bool | str, unit: Optional\[str\] = None)

Set the value of a module property.

- **Parameters:**
    - **property\_name** (*Union* \*\[\**str* *,* *ModulePropertyIdentifier* *\]*) – The name of the module property to set.
    - **value** (*float* *,* *bool* *or* *str*) – The value to set. If the property\_name references to an enum property then value must be an str value.
    - **unit** (*str*) – The unit for value, just for scalar properties. If no unit is provided, value is assumed to be the unit was set before.