## On this page

  

 

 # DVS::IVar Class Reference

 Last update: 16.07.2025 

Interface for variables for the DVS Reader API. [More...](class_d_v_s_1_1_i_var.xhtml#details)

`#include <<a class="el" href="dvs__var__interface_8h_source.xhtml">dvs_var_interface.h</a>>`

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

<a id="a102df9a173523a896419011582abefb1"></a> [IVar](class_d_v_s_1_1_i_var.xhtml#a102df9a173523a896419011582abefb1) ()=default default   
 <a id="a0f21e53225c764cb3441f36c32f77bee"></a>virtual [~IVar](class_d_v_s_1_1_i_var.xhtml#a0f21e53225c764cb3441f36c32f77bee) ()=default default   
 <a id="aac24d89cca155832661aaf190e933e30"></a> [IVar](class_d_v_s_1_1_i_var.xhtml#aac24d89cca155832661aaf190e933e30) ([IVar](class_d_v_s_1_1_i_var.xhtml) &amp;&amp;)=default default   
 <a id="acac7ddfc292e8998c4ae66ace02c3bbc"></a>[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 default   
 <a id="afd5bd19f8cf769575e1d6f13890c876b"></a> [IVar](class_d_v_s_1_1_i_var.xhtml#afd5bd19f8cf769575e1d6f13890c876b) (const [IVar](class_d_v_s_1_1_i_var.xhtml) &amp;)=default support copying   
 <a id="a4fa7183cc37374962f46cd3aa84eac0d"></a>[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 default   
 virtual const char \* [get\_name](class_d_v_s_1_1_i_var.xhtml#af9d82173f26ea832cd2d9dcc9742bd56) () const =0 Get the name of the variable. [More...](class_d_v_s_1_1_i_var.xhtml#af9d82173f26ea832cd2d9dcc9742bd56)  
 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 Get the type of var. [More...](class_d_v_s_1_1_i_var.xhtml#ae837af2ee946d8f54695d1abf95c5cda)  
 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 Get the var location. [More...](class_d_v_s_1_1_i_var.xhtml#a7e97f43d3d1057267399c0e66deadd3d)  
 virtual uint32\_t [get\_float\_count\_per\_value](class_d_v_s_1_1_i_var.xhtml#a9dbdd84e6f6342deae82ede6dcf2156e) () const =0 Get the number of floats per value. [More...](class_d_v_s_1_1_i_var.xhtml#a9dbdd84e6f6342deae82ede6dcf2156e)  
 virtual const char \* [get\_unit\_dimension](class_d_v_s_1_1_i_var.xhtml#ab5a4abf4b5a1d319f4cd3651f03df6b3) () const =0 Get the unit dimensions as string. [More...](class_d_v_s_1_1_i_var.xhtml#ab5a4abf4b5a1d319f4cd3651f03df6b3)  
 virtual const char \* [get\_unit\_label](class_d_v_s_1_1_i_var.xhtml#a4d5cad1da5b03c0a35d199de4c00799b) () const =0 Get the unit label as string. [More...](class_d_v_s_1_1_i_var.xhtml#a4d5cad1da5b03c0a35d199de4c00799b)  
 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 Get the reference dataset for this var. [More...](class_d_v_s_1_1_i_var.xhtml#a2e0600d91a89b39455ca1386998851c3)  
 virtual uint32\_t [get\_num\_metadata](class_d_v_s_1_1_i_var.xhtml#a2deab60f72955106a4a4a3f67a0f295e) () const =0 Get the num metadata values on this var. [More...](class_d_v_s_1_1_i_var.xhtml#a2deab60f72955106a4a4a3f67a0f295e)  
 virtual const char \* [get\_metadata\_key](class_d_v_s_1_1_i_var.xhtml#a2b96533361edb6e64c7a4eb4a80d39f3) (uint32\_t index) const =0 Get a metadata key based on the index. [More...](class_d_v_s_1_1_i_var.xhtml#a2b96533361edb6e64c7a4eb4a80d39f3)  
 virtual const char \* [get\_metadata\_value](class_d_v_s_1_1_i_var.xhtml#a970de1a0e394ebc738e503f072c6fc1b) (uint32\_t index) const =0 Get the metadata value base on the index. [More...](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#a2724bf3e3b01d66b909254a2a7a363f5) (const char \*key) const =0 Get the metadata value based on the key. [More...](class_d_v_s_1_1_i_var.xhtml#a2724bf3e3b01d66b909254a2a7a363f5)  
 <a id="details" name="details"></a>## Detailed Description

Interface for variables for the DVS Reader API.

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 [44](dvs__var__interface_8h_source.xhtml#l00044) of file [dvs\_var\_interface.h](dvs__var__interface_8h_source.xhtml).



## Member Function Documentation

<a id="a2e0600d91a89b39455ca1386998851c3"></a>## [◆ ](#a2e0600d91a89b39455ca1386998851c3)get\_dataset()

 virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml)\* DVS::IVar::get\_dataset  ( )  const  pure virtual 

Get the reference dataset for this var.

Returnsconst [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml "Interface for datasets for the DVS Reader API.")\* the reference to the dataset 



<a id="a9dbdd84e6f6342deae82ede6dcf2156e"></a>## [◆ ](#a9dbdd84e6f6342deae82ede6dcf2156e)get\_float\_count\_per\_value()

 virtual uint32\_t DVS::IVar::get\_float\_count\_per\_value  ( )  const  pure virtual 

Get the number of floats per value.

Gets the size of each value, i.e. a scalar is 1 a vector is 3 etc.

Returnsuint32\_t size of each value for the var 



<a id="a2b96533361edb6e64c7a4eb4a80d39f3"></a>## [◆ ](#a2b96533361edb6e64c7a4eb4a80d39f3)get\_metadata\_key()

 virtual const char\* DVS::IVar::get\_metadata\_key  ( uint32\_t  *index*)  const  pure virtual 

Get a metadata key based on the index.

Parameters indexindex of the key to return Returnsconst char\* key for the metadata, nullptr if not found 



<a id="a2724bf3e3b01d66b909254a2a7a363f5"></a>## [◆ ](#a2724bf3e3b01d66b909254a2a7a363f5)get\_metadata\_value() \[1/2\]

 virtual const char\* DVS::IVar::get\_metadata\_value  ( const char \*  *key*)  const  pure virtual 

Get the metadata value based on the key.

Parameters keythe key to return the value of Returnsconst char\* value for the key, nullptr if not found 



<a id="a970de1a0e394ebc738e503f072c6fc1b"></a>## [◆ ](#a970de1a0e394ebc738e503f072c6fc1b)get\_metadata\_value() \[2/2\]

 virtual const char\* DVS::IVar::get\_metadata\_value  ( uint32\_t  *index*)  const  pure virtual 

Get the metadata value base on the index.

Parameters indexindex of the value to return Returnsconst char\* value for the metadata, nullptr if not found 



<a id="af9d82173f26ea832cd2d9dcc9742bd56"></a>## [◆ ](#af9d82173f26ea832cd2d9dcc9742bd56)get\_name()

 virtual const char\* DVS::IVar::get\_name  ( )  const  pure virtual 

Get the name of the variable.

Returnsconst char\* name of variable 



<a id="a2deab60f72955106a4a4a3f67a0f295e"></a>## [◆ ](#a2deab60f72955106a4a4a3f67a0f295e)get\_num\_metadata()

 virtual uint32\_t DVS::IVar::get\_num\_metadata  ( )  const  pure virtual 

Get the num metadata values on this var.

Returnsuint32\_t number of metadata keys/values 



<a id="ab5a4abf4b5a1d319f4cd3651f03df6b3"></a>## [◆ ](#ab5a4abf4b5a1d319f4cd3651f03df6b3)get\_unit\_dimension()

 virtual const char\* DVS::IVar::get\_unit\_dimension  ( )  const  pure virtual 

Get the unit dimensions as string.

Returnsconst char\* string of unit dimensions 



<a id="a4d5cad1da5b03c0a35d199de4c00799b"></a>## [◆ ](#a4d5cad1da5b03c0a35d199de4c00799b)get\_unit\_label()

 virtual const char\* DVS::IVar::get\_unit\_label  ( )  const  pure virtual 

Get the unit label as string.

This is a specialized name referring to the dimensions

Returnsconst char\* string of unit label 



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

 virtual [dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491) DVS::IVar::get\_var\_location  ( )  const  pure virtual 

Get the var location.

Returnsdvs\_var\_location location of var 



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

 virtual [dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) DVS::IVar::get\_var\_type  ( )  const  pure virtual 

Get the type of var.

Returnsdvs\_var\_type type of var 



---

The documentation for this class was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/user\_defined\_src/readers/dvs/include/[dvs\_var\_interface.h](dvs__var__interface_8h_source.xhtml)