## On this page

  

 

 # dvs\_dataset\_interface

 Last update: 16.07.2025 

[Go to the documentation of this file.](dvs__dataset__interface_8h.xhtml)<a id="l00001" name="l00001"></a> 1 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00002" name="l00002"></a> 2 \*

<a id="l00003" name="l00003"></a> 3 \* (C) 2021 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

<a id="l00004" name="l00004"></a> 4 \*

<a id="l00005" name="l00005"></a> 5 \* Restricted Rights Legend

<a id="l00006" name="l00006"></a> 6 \*

<a id="l00007" name="l00007"></a> 7 \* Use, duplication, or disclosure of this

<a id="l00008" name="l00008"></a> 8 \* software and its documentation by the

<a id="l00009" name="l00009"></a> 9 \* Government is subject to restrictions as

<a id="l00010" name="l00010"></a> 10 \* set forth in subdivision \[(b)(3)(ii)\] of

<a id="l00011" name="l00011"></a> 11 \* the Rights in Technical Data and Computer

<a id="l00012" name="l00012"></a> 12 \* Software clause at 52.227-7013.

<a id="l00013" name="l00013"></a> 13 \*

<a id="l00014" name="l00014"></a> 14 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00015" name="l00015"></a> 15 \*/

<a id="l00016" name="l00016"></a> 16 

<a id="l00023" name="l00023"></a> 23 \#ifndef \_\_\_DVS\_DATASET\_INTERFACE\_H\_\_\_

<a id="l00024" name="l00024"></a> 24 \#define \_\_\_DVS\_DATASET\_INTERFACE\_H\_\_\_

<a id="l00025" name="l00025"></a> 25 

<a id="l00026" name="l00026"></a> 26 \#include "[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)"

<a id="l00027" name="l00027"></a> 27 \#include "[dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml)"

<a id="l00028" name="l00028"></a> 28 

<a id="l00029" name="l00029"></a> 29 \#include "[dvs\_object\_interface.h](dvs__object__interface_8h.xhtml)"

<a id="l00030" name="l00030"></a> 30 \#include "[dvs\_var\_interface.h](dvs__var__interface_8h.xhtml)"

<a id="l00031" name="l00031"></a> 31 

<a id="l00032" name="l00032"></a> 32 namespace DVS

<a id="l00033" name="l00033"></a> 33 {

<a id="l00034" name="l00034"></a> 34 

<a id="l00043" name="l00043"></a>[ 43](class_d_v_s_1_1_i_dataset.xhtml) class [IDataset](class_d_v_s_1_1_i_dataset.xhtml) : public [IObject](class_d_v_s_1_1_i_object.xhtml)

<a id="l00044" name="l00044"></a> 44 {

<a id="l00045" name="l00045"></a> 45 public:

<a id="l00046" name="l00046"></a> 46 

<a id="l00047" name="l00047"></a>[ 47](class_d_v_s_1_1_i_dataset.xhtml#a5f47221543a890f8c04c7297f45e9580) [IDataset](class_d_v_s_1_1_i_dataset.xhtml#a5f47221543a890f8c04c7297f45e9580)() = default; 

<a id="l00048" name="l00048"></a>[ 48](class_d_v_s_1_1_i_dataset.xhtml#a99d31f6d38bc358af557ca2fa236959e) virtual [~IDataset](class_d_v_s_1_1_i_dataset.xhtml#a99d31f6d38bc358af557ca2fa236959e)() = default; 

<a id="l00049" name="l00049"></a>[ 49](class_d_v_s_1_1_i_dataset.xhtml#a4fafacbcd842db2b73a89b98d56f8ab4) [IDataset](class_d_v_s_1_1_i_dataset.xhtml#a4fafacbcd842db2b73a89b98d56f8ab4)([IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp;&amp;) = default; 

<a id="l00050" name="l00050"></a>[ 50](class_d_v_s_1_1_i_dataset.xhtml#a9cdcf0f0423af203bf36429a2a8e992a) [IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp; [operator=](class_d_v_s_1_1_i_dataset.xhtml#a9cdcf0f0423af203bf36429a2a8e992a)([IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp;&amp;) = default; 

<a id="l00051" name="l00051"></a>[ 51](class_d_v_s_1_1_i_dataset.xhtml#aa32d8780f6b7ed895870bea816396600) [IDataset](class_d_v_s_1_1_i_dataset.xhtml#aa32d8780f6b7ed895870bea816396600)(const [IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp;) = default; 

<a id="l00052" name="l00052"></a>[ 52](class_d_v_s_1_1_i_dataset.xhtml#ad87e6320180a03e49e14d0bd2d350987) [IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp; [operator=](class_d_v_s_1_1_i_dataset.xhtml#ad87e6320180a03e49e14d0bd2d350987)(const [IDataset](class_d_v_s_1_1_i_dataset.xhtml)&amp;) = default; 

<a id="l00053" name="l00053"></a> 53 

<a id="l00059" name="l00059"></a>[ 59](class_d_v_s_1_1_i_dataset.xhtml#a58184590f98127577ba91292064ccb75) virtual const char* [get\_unit\_system](class_d_v_s_1_1_i_dataset.xhtml#a58184590f98127577ba91292064ccb75)() const = 0;

<a id="l00060" name="l00060"></a> 60 

<a id="l00066" name="l00066"></a>[ 66](class_d_v_s_1_1_i_dataset.xhtml#a423774f63a6f5275d4d4f33da65f37b4) virtual uint32_t [get\_num\_ranks](class_d_v_s_1_1_i_dataset.xhtml#a423774f63a6f5275d4d4f33da65f37b4)() const = 0;

<a id="l00067" name="l00067"></a> 67 

<a id="l00076" name="l00076"></a>[ 76](class_d_v_s_1_1_i_dataset.xhtml#ac620a1f5fb513d636ed59d7b4552197a) 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;

<a id="l00077" name="l00077"></a> 77 

<a id="l00085" name="l00085"></a>[ 85](class_d_v_s_1_1_i_dataset.xhtml#a5ec19061a478d6b2aea0976b9e79f73b) virtual uint32_t [get\_num\_chunks\_per\_rank](class_d_v_s_1_1_i_dataset.xhtml#a5ec19061a478d6b2aea0976b9e79f73b)() const = 0;

<a id="l00086" name="l00086"></a> 86 

<a id="l00099" name="l00099"></a>[ 99](class_d_v_s_1_1_i_dataset.xhtml#afb023f6b10fd4c072e8c7cb140d666ae) 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;

<a id="l00100" name="l00100"></a> 100 

<a id="l00106" name="l00106"></a>[ 106](class_d_v_s_1_1_i_dataset.xhtml#a69aa8f4d0ad2c4fd69e6443f662fbc1d) virtual uint32_t [get\_num\_parts](class_d_v_s_1_1_i_dataset.xhtml#a69aa8f4d0ad2c4fd69e6443f662fbc1d)() const = 0;

<a id="l00107" name="l00107"></a> 107 

<a id="l00114" name="l00114"></a>[ 114](class_d_v_s_1_1_i_dataset.xhtml#ab71be7a6ec20c74eeccc625055bc0fb2) virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)* [get\_part](class_d_v_s_1_1_i_dataset.xhtml#ab71be7a6ec20c74eeccc625055bc0fb2)(uint32_t index) const = 0;

<a id="l00115" name="l00115"></a> 115 

<a id="l00121" name="l00121"></a>[ 121](class_d_v_s_1_1_i_dataset.xhtml#a49e3b27865d865ba36dd5d7e5c659a6b) virtual uint32_t [get\_num\_plots](class_d_v_s_1_1_i_dataset.xhtml#a49e3b27865d865ba36dd5d7e5c659a6b)() const = 0;

<a id="l00122" name="l00122"></a> 122 

<a id="l00129" name="l00129"></a>[ 129](class_d_v_s_1_1_i_dataset.xhtml#a465ce7d87c7291ce115b0b8d2b848703) virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)* [get\_plot](class_d_v_s_1_1_i_dataset.xhtml#a465ce7d87c7291ce115b0b8d2b848703)(uint32_t index) const = 0;

<a id="l00130" name="l00130"></a> 130 

<a id="l00136" name="l00136"></a>[ 136](class_d_v_s_1_1_i_dataset.xhtml#acd0c0e81b283bce8044d9b4de796574a) virtual uint32_t [get\_num\_variables](class_d_v_s_1_1_i_dataset.xhtml#acd0c0e81b283bce8044d9b4de796574a)() const = 0;

<a id="l00137" name="l00137"></a> 137 

<a id="l00144" name="l00144"></a>[ 144](class_d_v_s_1_1_i_dataset.xhtml#a52dd0a5187d92908761ddfae07a47273) virtual const [DVS::IVar](class_d_v_s_1_1_i_var.xhtml)* [get\_var](class_d_v_s_1_1_i_dataset.xhtml#a52dd0a5187d92908761ddfae07a47273)(uint32_t index) const = 0;

<a id="l00145" name="l00145"></a> 145 };

<a id="l00146" name="l00146"></a> 146 

<a id="l00147" name="l00147"></a> 147 } //namespace DVS

<a id="l00148" name="l00148"></a> 148 

<a id="l00149" name="l00149"></a> 149 \#endif //\_\_\_DVS\_DATASET\_INTERFACE\_H\_\_\_

[DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml)

Interface for datasets for the DVS Reader API.

**Definition:** [dvs\_dataset\_interface.h:44](dvs__dataset__interface_8h_source.xhtml#l00043)



[DVS::IDataset::get\_num\_ranks](class_d_v_s_1_1_i_dataset.xhtml#a423774f63a6f5275d4d4f33da65f37b4)

virtual uint32_t get_num_ranks() const =0

Get the number of ranks for the dataset.



[DVS::IDataset::get\_plot](class_d_v_s_1_1_i_dataset.xhtml#a465ce7d87c7291ce115b0b8d2b848703)

virtual const DVS::IObject * get_plot(uint32_t index) const =0

Get the plot object.



[DVS::IDataset::get\_num\_plots](class_d_v_s_1_1_i_dataset.xhtml#a49e3b27865d865ba36dd5d7e5c659a6b)

virtual uint32_t get_num_plots() const =0

Get the number of plots for this datasets.



[DVS::IDataset::IDataset](class_d_v_s_1_1_i_dataset.xhtml#a4fafacbcd842db2b73a89b98d56f8ab4)

IDataset(IDataset &amp;&amp;)=default

default



[DVS::IDataset::get\_var](class_d_v_s_1_1_i_dataset.xhtml#a52dd0a5187d92908761ddfae07a47273)

virtual const DVS::IVar * get_var(uint32_t index) const =0

Get the var object.



[DVS::IDataset::get\_unit\_system](class_d_v_s_1_1_i_dataset.xhtml#a58184590f98127577ba91292064ccb75)

virtual const char * get_unit_system() const =0

Get the unit system of the dataset.



[DVS::IDataset::get\_num\_chunks\_per\_rank](class_d_v_s_1_1_i_dataset.xhtml#a5ec19061a478d6b2aea0976b9e79f73b)

virtual uint32_t get_num_chunks_per_rank() const =0

Get the size of the chunks_per_rank array for get_chunks_per_rank()



[DVS::IDataset::IDataset](class_d_v_s_1_1_i_dataset.xhtml#a5f47221543a890f8c04c7297f45e9580)

IDataset()=default

default



[DVS::IDataset::get\_num\_parts](class_d_v_s_1_1_i_dataset.xhtml#a69aa8f4d0ad2c4fd69e6443f662fbc1d)

virtual uint32_t get_num_parts() const =0

Get the number of parts for this dataset.



[DVS::IDataset::~IDataset](class_d_v_s_1_1_i_dataset.xhtml#a99d31f6d38bc358af557ca2fa236959e)

virtual ~IDataset()=default

default



[DVS::IDataset::operator=](class_d_v_s_1_1_i_dataset.xhtml#a9cdcf0f0423af203bf36429a2a8e992a)

IDataset &amp; operator=(IDataset &amp;&amp;)=default

default



[DVS::IDataset::IDataset](class_d_v_s_1_1_i_dataset.xhtml#aa32d8780f6b7ed895870bea816396600)

IDataset(const IDataset &amp;)=default

support copying



[DVS::IDataset::get\_part](class_d_v_s_1_1_i_dataset.xhtml#ab71be7a6ec20c74eeccc625055bc0fb2)

virtual const DVS::IObject * get_part(uint32_t index) const =0

Get a part by index.



[DVS::IDataset::get\_ranks](class_d_v_s_1_1_i_dataset.xhtml#ac620a1f5fb513d636ed59d7b4552197a)

virtual dvs_ret get_ranks(uint32_t *ranks) const =0

Get an array of the ranks for this dataset query.



[DVS::IDataset::get\_num\_variables](class_d_v_s_1_1_i_dataset.xhtml#acd0c0e81b283bce8044d9b4de796574a)

virtual uint32_t get_num_variables() const =0

Get the number of variables for this dataset.



[DVS::IDataset::operator=](class_d_v_s_1_1_i_dataset.xhtml#ad87e6320180a03e49e14d0bd2d350987)

IDataset &amp; operator=(const IDataset &amp;)=default

default



[DVS::IDataset::get\_chunks\_per\_rank](class_d_v_s_1_1_i_dataset.xhtml#afb023f6b10fd4c072e8c7cb140d666ae)

virtual dvs_ret get_chunks_per_rank(uint32_t *chunks_per_rank) const =0

Get the number of chunks for each rank.



[DVS::IObject](class_d_v_s_1_1_i_object.xhtml)

Interface for part/plot objects for DVS Reader API.

**Definition:** [dvs\_object\_interface.h:45](dvs__object__interface_8h_source.xhtml#l00044)



[DVS::IVar](class_d_v_s_1_1_i_var.xhtml)

Interface for variables for the DVS Reader API.

**Definition:** [dvs\_var\_interface.h:45](dvs__var__interface_8h_source.xhtml#l00044)



[dvs\_object\_interface.h](dvs__object__interface_8h.xhtml)

DVS Reader API Object Interface.



[dvs\_var\_interface.h](dvs__var__interface_8h.xhtml)

DVS Reader API Variable Interface.



[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)

Contains enums used in C/C++ API.



[dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml)

Contains errors used in the DVS C/C++ API.



[dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1)

int32_t dvs_ret

Return value of methods, TODO.

**Definition:** [dynamic\_visualization\_store\_error\_codes.h:17](dynamic__visualization__store__error__codes_8h_source.xhtml#l00017)