## On this page

  

 

 # IRockyPluginDataEntry Class Reference

 Last update: 16.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

bool [has](#a67a2a72cd88df362f2fbe128b6814c17) (const char \*\_name) const bool [get\_bool](#afb831ee2119c05117bde33db7e5f965c) (const char \*\_name) const int [get\_int](#ab1a99ba3c573dbfc7547cc35ded461be) (const char \*\_name) const double [get\_double](#af0df7ed2b038b1a48228a24b1b840692) (const char \*\_name) const std::string [get\_string](#a9e4a1299866b05178f910869689c7ac9) (const char \*\_name) const int [get\_list\_size](#ad0ca70feaf5f67d7ebb52802dad39989) (const char \*\_name) const [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) [get\_list\_item](#ab8a6c4631f842a5c2d724f4661287665) (const char \*\_name, int item\_index) const <a id="details" name="details"></a>## Detailed Description

`<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` is a data unit corresponding to a single entity in Rocky (a geometry, a material interaction, etc). It gives access to values of custom module data entered manually through the Rocky UI. `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` may contain boolean, integer, double precision, and string data. Data arranged in lists of `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` is also allowed. The value of a parameter is retrieved passing to the corresponding function the name string, as specified in the Python file that defines the components of the module.



## Member Function Documentation

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

 bool IRockyPluginDataEntry::get\_bool  ( const char \* *\_name*)  const

ReturnsThe boolean value specified for the given parameter in the Rocky UI through a checkbox.Parameters \_nameThe name of the boolean parameter, as specified in the module definition Python file. 



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

 double IRockyPluginDataEntry::get\_double  ( const char \* *\_name*)  const

ReturnsThe double precision value specified for the given parameter in the Rocky UI.Parameters \_nameThe name of the double precision parameter, as specified in the module definition Python file. 



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

 int IRockyPluginDataEntry::get\_int  ( const char \* *\_name*)  const

ReturnsThe integer value specified for the given parameter in the Rocky UI.Parameters \_nameThe name of the integer parameter, as specified in the module definition Python file. 



<a id="ab8a6c4631f842a5c2d724f4661287665" name="ab8a6c4631f842a5c2d724f4661287665"></a>## [◆ ](#ab8a6c4631f842a5c2d724f4661287665)get\_list\_item()

 [IRockyPluginDataEntry](classIRockyPluginDataEntry.xhtml) IRockyPluginDataEntry::get\_list\_item  ( const char \* *\_name*,    int *item\_index* ) const

ReturnsAn `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object contained in the list.Parameters \_nameThe name of the list, as specified in the module definition Python file.item\_indexThe index that specifies the position in the list of the item to be retrieved. 



<a id="ad0ca70feaf5f67d7ebb52802dad39989" name="ad0ca70feaf5f67d7ebb52802dad39989"></a>## [◆ ](#ad0ca70feaf5f67d7ebb52802dad39989)get\_list\_size()

 int IRockyPluginDataEntry::get\_list\_size  ( const char \* *\_name*)  const

ReturnsThe number of `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` objects that the list contains.Parameters \_nameThe name of the list, as specified in the module definition Python file. 



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

 std::string IRockyPluginDataEntry::get\_string  ( const char \* *\_name*)  const

ReturnsThe string value specified for the given parameter in the Rocky UI.Parameters \_nameThe name of the string parameter, as specified in the module definition Python file. 



<a id="a67a2a72cd88df362f2fbe128b6814c17" name="a67a2a72cd88df362f2fbe128b6814c17"></a>## [◆ ](#a67a2a72cd88df362f2fbe128b6814c17)has()

 bool IRockyPluginDataEntry::has  ( const char \* *\_name*)  const

ReturnsTrue if the parameter specified by name actually exists in the `<a class="el" href="classIRockyPluginDataEntry.xhtml">IRockyPluginDataEntry</a>` object. Otherwise, it returns false.Parameters \_nameThe name of the parameter, as specified in the module definition Python file