## On this page

  

 

 # IRockyPluginData Class Reference

 Last update: 17.07.2025 

`#include <<a class="el" href="rocky__plugin__data_8h_source.xhtml">rocky_plugin_data.h</a>>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

[IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_model](classIRockyPluginData.xhtml#ab65c417ed40c1bab14987f959c095b7d) () const bool [has\_material\_interaction\_data](classIRockyPluginData.xhtml#aefed471c915106b82ca654eef4a03042) () const int [get\_number\_material\_interactions](classIRockyPluginData.xhtml#a90cc066bcc4f454a5c9d21d69bf57e9e) () const [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_material\_interaction\_data](classIRockyPluginData.xhtml#a78c76a74cd026948ee16f3b6b4718356) (int index) const bool [has\_geometry\_data](classIRockyPluginData.xhtml#a46306bc4ec8fe3a85efc85c37b78fdfb) () const int [get\_number\_geometries](classIRockyPluginData.xhtml#a413adf0e206156e543c8dd170eee387e) () const [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_geometry\_data](classIRockyPluginData.xhtml#ae830fad6e94d455f0e4ad57df4b981de) (int index) const bool [has\_particle\_group\_data](classIRockyPluginData.xhtml#af000e5f6b3f1d9f454233b01c8a43515) () const int [get\_number\_particle\_groups](classIRockyPluginData.xhtml#a7a39deb0a0b9b782ad0e74e82bc027ce) () const [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_particle\_group\_data](classIRockyPluginData.xhtml#a224e42565c6730227d5f85c8d0f0004f) (int index) const bool [has\_material\_data](classIRockyPluginData.xhtml#af8d04f332d01ab25b7a375552072db2a) () const int [get\_number\_materials](classIRockyPluginData.xhtml#ae0a075e183d876a183d37f2c7e818ca4) () const [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_material\_data](classIRockyPluginData.xhtml#a5c7b4ed26d1a6787279d2c531444666b) (int index) const <a id="details" name="details"></a>## Detailed Description

`<a class="el" href="classIRockyPluginData.xhtml">IRockyPluginData</a>` gathers custom module data entered manually through the Rocky UI. In order to appear on the Rocky UI, custom modules parameters must be specified in the Python file that defines the components of the module. An `<a class="el" href="classIRockyPluginData.xhtml">IRockyPluginData</a>` object is only available during the configuration step in `ROCKY_PLUGIN_CONFIGURE`.



## Member Function Documentation

<a id="ae830fad6e94d455f0e4ad57df4b981de" name="ae830fad6e94d455f0e4ad57df4b981de"></a>## [◆ ](#ae830fad6e94d455f0e4ad57df4b981de)get\_geometry\_data()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginData::get\_geometry\_data  ( int  *index*)  const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the *geometry* (boundaries) section.Parameters indexThe index that uniquely identifies the specific geometry whose data must be retrieved. 



<a id="a5c7b4ed26d1a6787279d2c531444666b" name="a5c7b4ed26d1a6787279d2c531444666b"></a>## [◆ ](#a5c7b4ed26d1a6787279d2c531444666b)get\_material\_data()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginData::get\_material\_data  ( int  *index*)  const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the *material* section.Parameters indexThe index that uniquely identifies the specific material whose data must be retrieved. 



<a id="a78c76a74cd026948ee16f3b6b4718356" name="a78c76a74cd026948ee16f3b6b4718356"></a>## [◆ ](#a78c76a74cd026948ee16f3b6b4718356)get\_material\_interaction\_data()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginData::get\_material\_interaction\_data  ( int  *index*)  const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object that gives access to the values entered through the Rocky UI, if they exist, for all parameters defined in the *material interactions* section of the module.Parameters indexThe index that uniquely identifies the specific material interaction whose data must be retrieved. 



<a id="ab65c417ed40c1bab14987f959c095b7d" name="ab65c417ed40c1bab14987f959c095b7d"></a>## [◆ ](#ab65c417ed40c1bab14987f959c095b7d)get\_model()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginData::get\_model  ( )  const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object that gives access to the values entered through the Rocky UI for all parameters in the *model* section of the module. These parameters are displayed in the \[Data Editors\] panel when the module is selected in the data tree. 



<a id="a413adf0e206156e543c8dd170eee387e" name="a413adf0e206156e543c8dd170eee387e"></a>## [◆ ](#a413adf0e206156e543c8dd170eee387e)get\_number\_geometries()

 int IRockyPluginData::get\_number\_geometries  ( )  const

ReturnsThe total number of geometries (boundaries) in the project. 



<a id="a90cc066bcc4f454a5c9d21d69bf57e9e" name="a90cc066bcc4f454a5c9d21d69bf57e9e"></a>## [◆ ](#a90cc066bcc4f454a5c9d21d69bf57e9e)get\_number\_material\_interactions()

 int IRockyPluginData::get\_number\_material\_interactions  ( )  const

ReturnsThe total number of material interactions that it is possible to define with the current materials defined in the Rocky project. 



<a id="ae0a075e183d876a183d37f2c7e818ca4" name="ae0a075e183d876a183d37f2c7e818ca4"></a>## [◆ ](#ae0a075e183d876a183d37f2c7e818ca4)get\_number\_materials()

 int IRockyPluginData::get\_number\_materials  ( )  const

ReturnsThe total number of materials defined in the project. 



<a id="a7a39deb0a0b9b782ad0e74e82bc027ce" name="a7a39deb0a0b9b782ad0e74e82bc027ce"></a>## [◆ ](#a7a39deb0a0b9b782ad0e74e82bc027ce)get\_number\_particle\_groups()

 int IRockyPluginData::get\_number\_particle\_groups  ( )  const

ReturnsThe total number of particle groups defined in the project. 



<a id="a224e42565c6730227d5f85c8d0f0004f" name="a224e42565c6730227d5f85c8d0f0004f"></a>## [◆ ](#a224e42565c6730227d5f85c8d0f0004f)get\_particle\_group\_data()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginData::get\_particle\_group\_data  ( int  *index*)  const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object that gives access to the values entered through the Rocky UI, if they exist, for all parameters associated specifically to the module defined in the *particle group* section.Parameters indexThe index that uniquely identifies the specific particle group whose data must be retrieved. 



<a id="a46306bc4ec8fe3a85efc85c37b78fdfb" name="a46306bc4ec8fe3a85efc85c37b78fdfb"></a>## [◆ ](#a46306bc4ec8fe3a85efc85c37b78fdfb)has\_geometry\_data()

 bool IRockyPluginData::has\_geometry\_data  ( )  const

ReturnsTrue if there is geometry data defined for the module, false otherwise. 



<a id="af8d04f332d01ab25b7a375552072db2a" name="af8d04f332d01ab25b7a375552072db2a"></a>## [◆ ](#af8d04f332d01ab25b7a375552072db2a)has\_material\_data()

 bool IRockyPluginData::has\_material\_data  ( )  const

ReturnsTrue if there is any material property data defined for the module, false otherwise. 



<a id="aefed471c915106b82ca654eef4a03042" name="aefed471c915106b82ca654eef4a03042"></a>## [◆ ](#aefed471c915106b82ca654eef4a03042)has\_material\_interaction\_data()

 bool IRockyPluginData::has\_material\_interaction\_data  ( )  const

ReturnsTrue if there is custom material interaction data defined for the module, false otherwise. 



<a id="af000e5f6b3f1d9f454233b01c8a43515" name="af000e5f6b3f1d9f454233b01c8a43515"></a>## [◆ ](#af000e5f6b3f1d9f454233b01c8a43515)has\_particle\_group\_data()

 bool IRockyPluginData::has\_particle\_group\_data  ( )  const

ReturnsTrue if there is particle group data defined for the module, false otherwise.