RAModule

class RAModule

Rocky PrePost Scripting wrapper for an individual module in a project, below the “Modules” item. Retrieve individual module from the RAModuleCollection via:

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

Methods:

Name	Description
DisableModule()	Disable the module.
EnableModule()	Enable the module.
GetModuleProperties()	Get the names of the module properties.
GetModuleProperty(property_name[, unit])	Get the value of a module property.
GetOutputObject()	Get the API object that represents this module's unique simulation results, if it exists.
GetValidOptionsForModuleProperty(property_name)	Get all valid options only for properties that have a list of possible options.
IsModuleEnabled()	Check if the module is enabled.
SetModuleEnabled(enabled)	Enable or disable the module.
SetModuleProperty(property_name, value[, unit])	Set the value of a module property.

DisableModule()

Disable the module.

EnableModule()

Enable the module.

GetModuleProperties()

Get the names of the module properties.

• Return type: tuple(ModulePropertyIdentifier)

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

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.

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]

IsModuleEnabled()

Check if the module is enabled.

• Return type: bool

SetModuleEnabled(enabled)

Enable or disable the module.

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

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.