## On this page

  

 

 # dvs\_var\_hash\_interface

 Last update: 16.07.2025 

[Go to the documentation of this file.](dvs__var__hash__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) 2022 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\_HASH\_INTERFACE\_H\_\_\_

<a id="l00025" name="l00025"></a> 25\#define \_\_\_DVS\_VAR\_HASH\_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\#include "[dvs\_var\_interface.h](dvs__var__interface_8h.xhtml)"

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

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

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

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

<a id="l00039" name="l00039"></a>[ 39](class_d_v_s_1_1_i_var_hash.xhtml)class [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)

<a id="l00040" name="l00040"></a> 40{

<a id="l00041" name="l00041"></a> 41public:

<a id="l00042" name="l00042"></a> 42 

<a id="l00043" name="l00043"></a>[ 43](class_d_v_s_1_1_i_var_hash.xhtml#a9b1a7d92f3c9c67d25be7b2cc4658b95) [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a9b1a7d92f3c9c67d25be7b2cc4658b95)() = default; 

<a id="l00044" name="l00044"></a>[ 44](class_d_v_s_1_1_i_var_hash.xhtml#a7b2a92106ec38f910d49a1c179419871) virtual [~IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a7b2a92106ec38f910d49a1c179419871)() = default; 

<a id="l00045" name="l00045"></a>[ 45](class_d_v_s_1_1_i_var_hash.xhtml#ae9c19f92692dee9f5d287ebc6e059dfb) [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#ae9c19f92692dee9f5d287ebc6e059dfb)([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp;&amp;) = default; 

<a id="l00046" name="l00046"></a>[ 46](class_d_v_s_1_1_i_var_hash.xhtml#a53d713fd8e14a28ad11fefb30c2fda03) [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp; [operator=](class_d_v_s_1_1_i_var_hash.xhtml#a53d713fd8e14a28ad11fefb30c2fda03)([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp;&amp;) = default; 

<a id="l00047" name="l00047"></a>[ 47](class_d_v_s_1_1_i_var_hash.xhtml#a056227972d92b22777ee19f60e1794f6) [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a056227972d92b22777ee19f60e1794f6)(const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp;) = default; 

<a id="l00048" name="l00048"></a>[ 48](class_d_v_s_1_1_i_var_hash.xhtml#a6aba4bc5fbf125a434cbb88f94a0dfb2) [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp; [operator=](class_d_v_s_1_1_i_var_hash.xhtml#a6aba4bc5fbf125a434cbb88f94a0dfb2)(const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)&amp;) = default; 

<a id="l00049" name="l00049"></a> 49 

<a id="l00057" name="l00057"></a>[ 57](class_d_v_s_1_1_i_var_hash.xhtml#a85c3ade756029207e15b1c8de8cd5c1b) virtual uint32_t [get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a85c3ade756029207e15b1c8de8cd5c1b)(uint32_t index, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type = VAR_TYPE::FLOAT) const = 0;

<a id="l00058" name="l00058"></a> 58 

<a id="l00065" name="l00065"></a>[ 65](class_d_v_s_1_1_i_var_hash.xhtml#a81cd99bbf69ccc0d50e8bcb7dd291046) virtual uint32_t [get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a81cd99bbf69ccc0d50e8bcb7dd291046)(const [IVar](class_d_v_s_1_1_i_var.xhtml)* var) const = 0;

<a id="l00066" name="l00066"></a> 66 

<a id="l00085" name="l00085"></a>[ 85](class_d_v_s_1_1_i_var_hash.xhtml#a17fff1548eb276edd326a0af08f6a7c4) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a17fff1548eb276edd326a0af08f6a7c4)(uint32_t index, char* hash, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type = VAR_TYPE::FLOAT) const = 0;

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

<a id="l00105" name="l00105"></a>[ 105](class_d_v_s_1_1_i_var_hash.xhtml#a7348be86da47ac034252a68949b21007) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a7348be86da47ac034252a68949b21007)(const [IVar](class_d_v_s_1_1_i_var.xhtml)* var, char* hash) const = 0;

<a id="l00106" name="l00106"></a> 106};

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

<a id="l00108" name="l00108"></a> 108} //namespace DVS

<a id="l00109" name="l00109"></a> 109 

<a id="l00110" name="l00110"></a> 110\#endif //\_\_\_DVS\_VAR\_HASH\_INTERFACE\_H\_\_\_

[DVS::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml)

Interface to get variable hash information from DVS objects.

**Definition:** [dvs\_var\_hash\_interface.h:40](dvs__var__hash__interface_8h_source.xhtml#l00039)



[DVS::IVarHash::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a056227972d92b22777ee19f60e1794f6)

IVarHash(const IVarHash &amp;)=default

support copying



[DVS::IVarHash::get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a17fff1548eb276edd326a0af08f6a7c4)

virtual dvs_ret get_var_hash(uint32_t index, char *hash, VAR_TYPE type=VAR_TYPE::FLOAT) const =0

Get the hash of the variable data.



[DVS::IVarHash::operator=](class_d_v_s_1_1_i_var_hash.xhtml#a53d713fd8e14a28ad11fefb30c2fda03)

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

default



[DVS::IVarHash::operator=](class_d_v_s_1_1_i_var_hash.xhtml#a6aba4bc5fbf125a434cbb88f94a0dfb2)

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

default



[DVS::IVarHash::get\_var\_hash](class_d_v_s_1_1_i_var_hash.xhtml#a7348be86da47ac034252a68949b21007)

virtual dvs_ret get_var_hash(const IVar *var, char *hash) const =0

Get the hash of the variable data.



[DVS::IVarHash::~IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a7b2a92106ec38f910d49a1c179419871)

virtual ~IVarHash()=default

default



[DVS::IVarHash::get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a81cd99bbf69ccc0d50e8bcb7dd291046)

virtual uint32_t get_var_hash_size(const IVar *var) const =0

Get the size of the hash to use with IVarHash::get_var_hash()



[DVS::IVarHash::get\_var\_hash\_size](class_d_v_s_1_1_i_var_hash.xhtml#a85c3ade756029207e15b1c8de8cd5c1b)

virtual uint32_t get_var_hash_size(uint32_t index, VAR_TYPE type=VAR_TYPE::FLOAT) const =0

Get the size of the hash to use with IVarHash::get_var_hash()



[DVS::IVarHash::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#a9b1a7d92f3c9c67d25be7b2cc4658b95)

IVarHash()=default

default



[DVS::IVarHash::IVarHash](class_d_v_s_1_1_i_var_hash.xhtml#ae9c19f92692dee9f5d287ebc6e059dfb)

IVarHash(IVarHash &amp;&amp;)=default

default



[DVS::IVar](class_d_v_s_1_1_i_var.xhtml)

Interface for variables for the DVS Reader API.

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



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

DVS Reader API Variable Interface.



[DVS::VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066)

VAR_TYPE

Variable type enum definition.

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



[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:32](dynamic__visualization__store__error__codes_8h_source.xhtml#l00032)