## On this page

  

 

 # DVS::IDataset Class Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="dvs__dataset__interface_8h_source.xhtml">dvs_dataset_interface.h</a>>`

Inheritance diagram for DVS::IDataset:

 ![](/sites/default/files/migrate-content/postprocessing_2024_r2/class_d_v_s_1_1_i_dataset.png)



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

<a id="a5f47221543a890f8c04c7297f45e9580" name="a5f47221543a890f8c04c7297f45e9580"></a> **IDataset** ()=default <a id="a99d31f6d38bc358af557ca2fa236959e" name="a99d31f6d38bc358af557ca2fa236959e"></a>virtual **~IDataset** ()=default <a id="a4fafacbcd842db2b73a89b98d56f8ab4" name="a4fafacbcd842db2b73a89b98d56f8ab4"></a> **IDataset** ([IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp;&amp;)=default <a id="a6ce85ff405ae57b21a5317b75874f128" name="a6ce85ff405ae57b21a5317b75874f128"></a>[IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp; **operator=** ([IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp;&amp;)=default <a id="aa32d8780f6b7ed895870bea816396600" name="aa32d8780f6b7ed895870bea816396600"></a> **IDataset** (const [IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp;)=default <a id="a0cd185542ff0c3d51d5a20762af02958" name="a0cd185542ff0c3d51d5a20762af02958"></a>[IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp; **operator=** (const [IDataset](class_d_v_s_1_1_i_dataset.xhtml) &amp;)=default virtual const char \* [get\_unit\_system](class_d_v_s_1_1_i_dataset.xhtml#af69301cb1a2d466933e8fee162411a60) () const =0 virtual uint32\_t [get\_num\_ranks](class_d_v_s_1_1_i_dataset.xhtml#a423774f63a6f5275d4d4f33da65f37b4) () const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_ranks](class_d_v_s_1_1_i_dataset.xhtml#ac620a1f5fb513d636ed59d7b4552197a) (uint32\_t \*ranks) const =0 virtual uint32\_t [get\_num\_chunks\_per\_rank](class_d_v_s_1_1_i_dataset.xhtml#a5ec19061a478d6b2aea0976b9e79f73b) () const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_chunks\_per\_rank](class_d_v_s_1_1_i_dataset.xhtml#afb023f6b10fd4c072e8c7cb140d666ae) (uint32\_t \*chunks\_per\_rank) const =0 virtual uint32\_t [get\_num\_parts](class_d_v_s_1_1_i_dataset.xhtml#a69aa8f4d0ad2c4fd69e6443f662fbc1d) () const =0 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* [get\_part](class_d_v_s_1_1_i_dataset.xhtml#af000ab1d7bfdd043cdc2b4f6cd4d682c) (uint32\_t index) const =0 virtual uint32\_t [get\_num\_plots](class_d_v_s_1_1_i_dataset.xhtml#a49e3b27865d865ba36dd5d7e5c659a6b) () const =0 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* [get\_plot](class_d_v_s_1_1_i_dataset.xhtml#a8f3bb3e37530f0b1dd6630fb6f9925f5) (uint32\_t index) const =0 virtual uint32\_t [get\_num\_variables](class_d_v_s_1_1_i_dataset.xhtml#acd0c0e81b283bce8044d9b4de796574a) () const =0 virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml) \* [get\_var](class_d_v_s_1_1_i_dataset.xhtml#abfef24372147723533c9feebd55666c1) (uint32\_t index) const =0 ![-](/sites/default/files/migrate-content/postprocessing_2024_r2/closed.png) Public Member Functions inherited from [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)<a id="ac8a6734ee192a26b574e9eec520c1495" name="ac8a6734ee192a26b574e9eec520c1495"></a> **IObject** ()=default <a id="a26912f7959e8f0e610074833c677a904" name="a26912f7959e8f0e610074833c677a904"></a>virtual **~IObject** ()=default <a id="aae99076e42a6fc37bf9a71303b3db2b5" name="aae99076e42a6fc37bf9a71303b3db2b5"></a> **IObject** ([IObject](class_d_v_s_1_1_i_object.xhtml) &amp;&amp;)=default <a id="ae90f3c11b1fdf916b59490005b148fd5" name="ae90f3c11b1fdf916b59490005b148fd5"></a>[IObject](class_d_v_s_1_1_i_object.xhtml) &amp; **operator=** ([IObject](class_d_v_s_1_1_i_object.xhtml) &amp;&amp;)=default <a id="af147aaab5200462fd620dbdd4a39ac76" name="af147aaab5200462fd620dbdd4a39ac76"></a> **IObject** (const [IObject](class_d_v_s_1_1_i_object.xhtml) &amp;)=default <a id="a9953812222e436976af29d1f84967f85" name="a9953812222e436976af29d1f84967f85"></a>[IObject](class_d_v_s_1_1_i_object.xhtml) &amp; **operator=** (const [IObject](class_d_v_s_1_1_i_object.xhtml) &amp;)=default virtual const char \* [get\_name](class_d_v_s_1_1_i_object.xhtml#a39be8b08200f75b20a7b5cf715ba9dd3) () const =0 virtual [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) [get\_type](class_d_v_s_1_1_i_object.xhtml#a889c46624013cc3802c7164d153b95f6) () const =0 virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml) \* [get\_dataset](class_d_v_s_1_1_i_object.xhtml#aea688a307b1cb02ae53e0e8fd3791e64) () const =0 virtual uint32\_t [get\_num\_metadata](class_d_v_s_1_1_i_object.xhtml#a31db3b716cc815c2c73f826f24384f6a) () const =0 virtual const char \* [get\_metadata\_key](class_d_v_s_1_1_i_object.xhtml#a04ee2919ffeb46d966d4675c8cd4420c) (uint32\_t index) const =0 virtual const char \* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#a7a37d603ccf93f7f1ec9f962fa9d1f61) (uint32\_t index) const =0 virtual const char \* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#aa33105e0510c3a2b0da022d5e9632bc8) (const char \*key) const =0 ## <a id="inherited" name="inherited"></a>Additional Inherited Members

![-](/sites/default/files/migrate-content/postprocessing_2024_r2/closed.png) Public Types inherited from [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)enum [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) { [PART](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6), [PLOT](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae), [CASE](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd) } <a id="details" name="details"></a>## Detailed Description

This object's lifetime is controlled by the query it is returned from. If the filter or uri of the query is changed this object will be destroyed. If this is a chained query and any of the parent queries are modified this object will also be destroyed. See [dvs\_query\_interface.h](dvs__query__interface_8h.xhtml "DVS Reader API Query Interface.") for more information.

Definition at line [43](dvs__dataset__interface_8h_source.xhtml#l00043) of file [dvs\_dataset\_interface.h](dvs__dataset__interface_8h_source.xhtml).



## Member Function Documentation

<a id="afb023f6b10fd4c072e8c7cb140d666ae" name="afb023f6b10fd4c072e8c7cb140d666ae"></a>## [◆ ](#afb023f6b10fd4c072e8c7cb140d666ae)get\_chunks\_per\_rank()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IDataset::get\_chunks\_per\_rank  ( uint32\_t \*  *chunks\_per\_rank*)  const  pure virtual 

Get the number of chunks for each rank.

This method returns an array of the max number of chunks for each rank based on the filters of the query. The values correspond to the ranks returned from [IDataset::get\_ranks()](class_d_v_s_1_1_i_dataset.xhtml#ac620a1f5fb513d636ed59d7b4552197a "Get an array of the ranks for this dataset query."). Example: if get\_ranks returns ranks: \[0 2 5\] then this might return \[1 1 2\] based on the number of chunks this dataset was written with.

Parameters chunks\_per\_rankbuffer of size [DVS::IDataset::get\_num\_chunks\_per\_rank()](class_d_v_s_1_1_i_dataset.xhtml#a5ec19061a478d6b2aea0976b9e79f73b "Get the size of the chunks_per_rank array for get_chunks_per_rank()"), returns the number of chunks for each rank for this query/dataset Returnsdvs\_ret DVS\_NONE if no errors, otherwise see [dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml "Contains errors used in the DVS C/C++ API.") 



<a id="a5ec19061a478d6b2aea0976b9e79f73b" name="a5ec19061a478d6b2aea0976b9e79f73b"></a>## [◆ ](#a5ec19061a478d6b2aea0976b9e79f73b)get\_num\_chunks\_per\_rank()

 virtual uint32\_t DVS::IDataset::get\_num\_chunks\_per\_rank  ( )  const  pure virtual 

Get the size of the chunks\_per\_rank array for [get\_chunks\_per\_rank()](class_d_v_s_1_1_i_dataset.xhtml#afb023f6b10fd4c072e8c7cb140d666ae "Get the number of chunks for each rank.")

The size of this should match the number of ranks this dataset has

Returnsuint32\_t the number of chunks per ranks 



<a id="a69aa8f4d0ad2c4fd69e6443f662fbc1d" name="a69aa8f4d0ad2c4fd69e6443f662fbc1d"></a>## [◆ ](#a69aa8f4d0ad2c4fd69e6443f662fbc1d)get\_num\_parts()

 virtual uint32\_t DVS::IDataset::get\_num\_parts  ( )  const  pure virtual 

Get the number of parts for this dataset.

Returnsuint32\_t the number of parts 



<a id="a49e3b27865d865ba36dd5d7e5c659a6b" name="a49e3b27865d865ba36dd5d7e5c659a6b"></a>## [◆ ](#a49e3b27865d865ba36dd5d7e5c659a6b)get\_num\_plots()

 virtual uint32\_t DVS::IDataset::get\_num\_plots  ( )  const  pure virtual 

Get the number of plots for this datasets.

Returnsuint32\_t the number of plots for this dataset 



<a id="a423774f63a6f5275d4d4f33da65f37b4" name="a423774f63a6f5275d4d4f33da65f37b4"></a>## [◆ ](#a423774f63a6f5275d4d4f33da65f37b4)get\_num\_ranks()

 virtual uint32\_t DVS::IDataset::get\_num\_ranks  ( )  const  pure virtual 

Get the number of ranks for the dataset.

Returnsuint32\_t number of ranks 



<a id="acd0c0e81b283bce8044d9b4de796574a" name="acd0c0e81b283bce8044d9b4de796574a"></a>## [◆ ](#acd0c0e81b283bce8044d9b4de796574a)get\_num\_variables()

 virtual uint32\_t DVS::IDataset::get\_num\_variables  ( )  const  pure virtual 

Get the number of variables for this dataset.

Returnsuint32\_t the number of variable definitions 



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

 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* DVS::IDataset::get\_part  ( uint32\_t  *index*)  const  pure virtual 

Get a part by index.

Parameters indexindex of the part Returns[DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.")\* pointer to part object or nullptr if not found 



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

 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* DVS::IDataset::get\_plot  ( uint32\_t  *index*)  const  pure virtual 

Get the plot object.

Parameters indexthe index of the plot to retrieve Returns[DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.")\* pointer to [DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.") plot or nullptr 



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

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IDataset::get\_ranks  ( uint32\_t \*  *ranks*)  const  pure virtual 

Get an array of the ranks for this dataset query.

This method returns an array of the rank numbers for this dataset based on the query

Parameters \[out\]ranksbuffer of size [DVS::IDataset::get\_num\_ranks()](class_d_v_s_1_1_i_dataset.xhtml#a423774f63a6f5275d4d4f33da65f37b4 "Get the number of ranks for the dataset."), the ranks avaialble for this query/dataset Returnsdvs\_ret DVS\_NONE if no errors, otherwise see [dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml "Contains errors used in the DVS C/C++ API.") 



<a id="af69301cb1a2d466933e8fee162411a60" name="af69301cb1a2d466933e8fee162411a60"></a>## [◆ ](#af69301cb1a2d466933e8fee162411a60)get\_unit\_system()

 virtual const char \* DVS::IDataset::get\_unit\_system  ( )  const  pure virtual 

Get the unit system of the dataset.

Returnsconst char\* unit system of the dataset 



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

 virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml) \* DVS::IDataset::get\_var  ( uint32\_t  *index*)  const  pure virtual 

Get the var object.

Parameters indexthe index of the var to retrieve Returns[DVS::IVar](class_d_v_s_1_1_i_var.xhtml "Interface for variables for the DVS Reader API.")\* pointer to [DVS::IVar](class_d_v_s_1_1_i_var.xhtml "Interface for variables for the DVS Reader API.") object or nullptr 



---

The documentation for this class was generated from the following file:- D:/Product-src/ensight/user\_defined\_src/readers/dvs/include/[dvs\_dataset\_interface.h](dvs__dataset__interface_8h_source.xhtml)