## On this page

  

 

 # dvs\_var\_interface

 Last update: 16.07.2025 

[Go to the documentation of this file.](dvs__var__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="l00024" name="l00024"></a> 24 \#ifndef \_\_\_DVS\_VAR\_INTERFACE\_H\_\_\_

<a id="l00025" name="l00025"></a> 25 \#define \_\_\_DVS\_VAR\_INTERFACE\_H\_\_\_

<a id="l00026" name="l00026"></a> 26 

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

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

<a id="l00029" name="l00029"></a> 29 

<a id="l00030" name="l00030"></a> 30 namespace DVS

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

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

<a id="l00033" name="l00033"></a> 33 class IDataset;

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

<a id="l00044" name="l00044"></a>[ 44](class_d_v_s_1_1_i_var.xhtml) class [IVar](class_d_v_s_1_1_i_var.xhtml)

<a id="l00045" name="l00045"></a> 45 {

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

<a id="l00047" name="l00047"></a> 47 

<a id="l00048" name="l00048"></a>[ 48](class_d_v_s_1_1_i_var.xhtml#a102df9a173523a896419011582abefb1) [IVar](class_d_v_s_1_1_i_var.xhtml#a102df9a173523a896419011582abefb1)() = default; 

<a id="l00049" name="l00049"></a>[ 49](class_d_v_s_1_1_i_var.xhtml#a0f21e53225c764cb3441f36c32f77bee) virtual [~IVar](class_d_v_s_1_1_i_var.xhtml#a0f21e53225c764cb3441f36c32f77bee)() = default; 

<a id="l00050" name="l00050"></a>[ 50](class_d_v_s_1_1_i_var.xhtml#aac24d89cca155832661aaf190e933e30) [IVar](class_d_v_s_1_1_i_var.xhtml#aac24d89cca155832661aaf190e933e30)([IVar](class_d_v_s_1_1_i_var.xhtml)&amp;&amp;) = default; 

<a id="l00051" name="l00051"></a>[ 51](class_d_v_s_1_1_i_var.xhtml#acac7ddfc292e8998c4ae66ace02c3bbc) [IVar](class_d_v_s_1_1_i_var.xhtml)&amp; [operator=](class_d_v_s_1_1_i_var.xhtml#acac7ddfc292e8998c4ae66ace02c3bbc)([IVar](class_d_v_s_1_1_i_var.xhtml)&amp;&amp;) = default; 

<a id="l00052" name="l00052"></a>[ 52](class_d_v_s_1_1_i_var.xhtml#afd5bd19f8cf769575e1d6f13890c876b) [IVar](class_d_v_s_1_1_i_var.xhtml#afd5bd19f8cf769575e1d6f13890c876b)(const [IVar](class_d_v_s_1_1_i_var.xhtml)&amp;) = default; 

<a id="l00053" name="l00053"></a>[ 53](class_d_v_s_1_1_i_var.xhtml#a4fa7183cc37374962f46cd3aa84eac0d) [IVar](class_d_v_s_1_1_i_var.xhtml)&amp; [operator=](class_d_v_s_1_1_i_var.xhtml#a4fa7183cc37374962f46cd3aa84eac0d)(const [IVar](class_d_v_s_1_1_i_var.xhtml)&amp;) = default; 

<a id="l00054" name="l00054"></a> 54 

<a id="l00060" name="l00060"></a>[ 60](class_d_v_s_1_1_i_var.xhtml#af9d82173f26ea832cd2d9dcc9742bd56) virtual const char* [get\_name](class_d_v_s_1_1_i_var.xhtml#af9d82173f26ea832cd2d9dcc9742bd56)() const = 0;

<a id="l00061" name="l00061"></a> 61 

<a id="l00067" name="l00067"></a>[ 67](class_d_v_s_1_1_i_var.xhtml#ae837af2ee946d8f54695d1abf95c5cda) virtual [dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) [get\_var\_type](class_d_v_s_1_1_i_var.xhtml#ae837af2ee946d8f54695d1abf95c5cda)() const = 0;

<a id="l00068" name="l00068"></a> 68 

<a id="l00074" name="l00074"></a>[ 74](class_d_v_s_1_1_i_var.xhtml#a7e97f43d3d1057267399c0e66deadd3d) virtual [dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491) [get\_var\_location](class_d_v_s_1_1_i_var.xhtml#a7e97f43d3d1057267399c0e66deadd3d)() const = 0;

<a id="l00075" name="l00075"></a> 75 

<a id="l00084" name="l00084"></a>[ 84](class_d_v_s_1_1_i_var.xhtml#a9dbdd84e6f6342deae82ede6dcf2156e) virtual uint32_t [get\_float\_count\_per\_value](class_d_v_s_1_1_i_var.xhtml#a9dbdd84e6f6342deae82ede6dcf2156e)() const = 0;

<a id="l00085" name="l00085"></a> 85 

<a id="l00091" name="l00091"></a>[ 91](class_d_v_s_1_1_i_var.xhtml#ab5a4abf4b5a1d319f4cd3651f03df6b3) virtual const char* [get\_unit\_dimension](class_d_v_s_1_1_i_var.xhtml#ab5a4abf4b5a1d319f4cd3651f03df6b3)() const = 0;

<a id="l00092" name="l00092"></a> 92 

<a id="l00100" name="l00100"></a>[ 100](class_d_v_s_1_1_i_var.xhtml#a4d5cad1da5b03c0a35d199de4c00799b) virtual const char* [get\_unit\_label](class_d_v_s_1_1_i_var.xhtml#a4d5cad1da5b03c0a35d199de4c00799b)() const = 0;

<a id="l00101" name="l00101"></a> 101 

<a id="l00107" name="l00107"></a>[ 107](class_d_v_s_1_1_i_var.xhtml#a2e0600d91a89b39455ca1386998851c3) virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml)* [get\_dataset](class_d_v_s_1_1_i_var.xhtml#a2e0600d91a89b39455ca1386998851c3)() const = 0;

<a id="l00108" name="l00108"></a> 108 

<a id="l00114" name="l00114"></a>[ 114](class_d_v_s_1_1_i_var.xhtml#a2deab60f72955106a4a4a3f67a0f295e) virtual uint32_t [get\_num\_metadata](class_d_v_s_1_1_i_var.xhtml#a2deab60f72955106a4a4a3f67a0f295e)() const = 0;

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

<a id="l00122" name="l00122"></a>[ 122](class_d_v_s_1_1_i_var.xhtml#a2b96533361edb6e64c7a4eb4a80d39f3) virtual const char* [get\_metadata\_key](class_d_v_s_1_1_i_var.xhtml#a2b96533361edb6e64c7a4eb4a80d39f3)(uint32_t index) const = 0;

<a id="l00123" name="l00123"></a> 123 

<a id="l00130" name="l00130"></a>[ 130](class_d_v_s_1_1_i_var.xhtml#a970de1a0e394ebc738e503f072c6fc1b) virtual const char* [get\_metadata\_value](class_d_v_s_1_1_i_var.xhtml#a970de1a0e394ebc738e503f072c6fc1b)(uint32_t index) const = 0;

<a id="l00131" name="l00131"></a> 131 

<a id="l00138" name="l00138"></a>[ 138](class_d_v_s_1_1_i_var.xhtml#a2724bf3e3b01d66b909254a2a7a363f5) virtual const char* [get\_metadata\_value](class_d_v_s_1_1_i_var.xhtml#a2724bf3e3b01d66b909254a2a7a363f5)(const char* key) const = 0;

<a id="l00139" name="l00139"></a> 139 };

<a id="l00140" name="l00140"></a> 140 

<a id="l00141" name="l00141"></a> 141 } //namespace DVS

<a id="l00142" name="l00142"></a> 142 

<a id="l00143" name="l00143"></a> 143 \#endif //\_\_\_DVS\_VAR\_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::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::IVar::~IVar](class_d_v_s_1_1_i_var.xhtml#a0f21e53225c764cb3441f36c32f77bee)

virtual ~IVar()=default

default



[DVS::IVar::IVar](class_d_v_s_1_1_i_var.xhtml#a102df9a173523a896419011582abefb1)

IVar()=default

default



[DVS::IVar::get\_metadata\_value](class_d_v_s_1_1_i_var.xhtml#a2724bf3e3b01d66b909254a2a7a363f5)

virtual const char * get_metadata_value(const char *key) const =0

Get the metadata value based on the key.



[DVS::IVar::get\_metadata\_key](class_d_v_s_1_1_i_var.xhtml#a2b96533361edb6e64c7a4eb4a80d39f3)

virtual const char * get_metadata_key(uint32_t index) const =0

Get a metadata key based on the index.



[DVS::IVar::get\_num\_metadata](class_d_v_s_1_1_i_var.xhtml#a2deab60f72955106a4a4a3f67a0f295e)

virtual uint32_t get_num_metadata() const =0

Get the num metadata values on this var.



[DVS::IVar::get\_dataset](class_d_v_s_1_1_i_var.xhtml#a2e0600d91a89b39455ca1386998851c3)

virtual const DVS::IDataset * get_dataset() const =0

Get the reference dataset for this var.



[DVS::IVar::get\_unit\_label](class_d_v_s_1_1_i_var.xhtml#a4d5cad1da5b03c0a35d199de4c00799b)

virtual const char * get_unit_label() const =0

Get the unit label as string.



[DVS::IVar::operator=](class_d_v_s_1_1_i_var.xhtml#a4fa7183cc37374962f46cd3aa84eac0d)

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

default



[DVS::IVar::get\_var\_location](class_d_v_s_1_1_i_var.xhtml#a7e97f43d3d1057267399c0e66deadd3d)

virtual dvs_var_location get_var_location() const =0

Get the var location.



[DVS::IVar::get\_metadata\_value](class_d_v_s_1_1_i_var.xhtml#a970de1a0e394ebc738e503f072c6fc1b)

virtual const char * get_metadata_value(uint32_t index) const =0

Get the metadata value base on the index.



[DVS::IVar::get\_float\_count\_per\_value](class_d_v_s_1_1_i_var.xhtml#a9dbdd84e6f6342deae82ede6dcf2156e)

virtual uint32_t get_float_count_per_value() const =0

Get the number of floats per value.



[DVS::IVar::IVar](class_d_v_s_1_1_i_var.xhtml#aac24d89cca155832661aaf190e933e30)

IVar(IVar &amp;&amp;)=default

default



[DVS::IVar::get\_unit\_dimension](class_d_v_s_1_1_i_var.xhtml#ab5a4abf4b5a1d319f4cd3651f03df6b3)

virtual const char * get_unit_dimension() const =0

Get the unit dimensions as string.



[DVS::IVar::operator=](class_d_v_s_1_1_i_var.xhtml#acac7ddfc292e8998c4ae66ace02c3bbc)

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

default



[DVS::IVar::get\_var\_type](class_d_v_s_1_1_i_var.xhtml#ae837af2ee946d8f54695d1abf95c5cda)

virtual dvs_var_type get_var_type() const =0

Get the type of var.



[DVS::IVar::get\_name](class_d_v_s_1_1_i_var.xhtml#af9d82173f26ea832cd2d9dcc9742bd56)

virtual const char * get_name() const =0

Get the name of the variable.



[DVS::IVar::IVar](class_d_v_s_1_1_i_var.xhtml#afd5bd19f8cf769575e1d6f13890c876b)

IVar(const IVar &amp;)=default

support copying



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

Contains enums used in C/C++ API.



[dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491)

dvs_var_location

What variable is associated with.

**Definition:** [dynamic\_visualization\_store\_enums.h:18](dynamic__visualization__store__enums_8h_source.xhtml#l00017)



[dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0)

dvs_var_type

Data type of variable.

**Definition:** [dynamic\_visualization\_store\_enums.h:30](dynamic__visualization__store__enums_8h_source.xhtml#l00029)



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

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