## On this page

  

 

 # DVS::IVarHash Class Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="dvs__var__hash__interface_8h_source.xhtml">dvs_var_hash_interface.h</a>>`

Inheritance diagram for DVS::IVarHash:

 ![](/sites/default/files/migrate-content/postprocessing_2025_r1_1/class_d_v_s_1_1_i_var_hash.png)



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

<a id="a9b1a7d92f3c9c67d25be7b2cc4658b95" name="a9b1a7d92f3c9c67d25be7b2cc4658b95"></a> **IVarHash** ()=default <a id="a7b2a92106ec38f910d49a1c179419871" name="a7b2a92106ec38f910d49a1c179419871"></a>virtual **~IVarHash** ()=default <a id="ae9c19f92692dee9f5d287ebc6e059dfb" name="ae9c19f92692dee9f5d287ebc6e059dfb"></a> **IVarHash** ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;&amp;)=default <a id="a53d713fd8e14a28ad11fefb30c2fda03" name="a53d713fd8e14a28ad11fefb30c2fda03"></a>[IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp; **operator=** ([IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;&amp;)=default <a id="a056227972d92b22777ee19f60e1794f6" name="a056227972d92b22777ee19f60e1794f6"></a> **IVarHash** (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;)=default <a id="a6aba4bc5fbf125a434cbb88f94a0dfb2" name="a6aba4bc5fbf125a434cbb88f94a0dfb2"></a>[IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp; **operator=** (const [IVarHash](class_d_v_s_1_1_i_var_hash.xhtml) &amp;)=default virtual uint32\_t [get\_var\_hash\_size](#a85c3ade756029207e15b1c8de8cd5c1b) (uint32\_t index, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual uint32\_t [get\_var\_hash\_size](#a81cd99bbf69ccc0d50e8bcb7dd291046) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](#a17fff1548eb276edd326a0af08f6a7c4) (uint32\_t index, char \*hash, [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) type=VAR\_TYPE::FLOAT) const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_hash](#a7348be86da47ac034252a68949b21007) (const [IVar](class_d_v_s_1_1_i_var.xhtml) \*var, char \*hash) const =0 <a id="details" name="details"></a>## Detailed Description

Definition at line [39](dvs__var__hash__interface_8h_source.xhtml#l00039) of file [dvs\_var\_hash\_interface.h](dvs__var__hash__interface_8h_source.xhtml).



## Member Function Documentation

<a id="a7348be86da47ac034252a68949b21007" name="a7348be86da47ac034252a68949b21007"></a>## [◆ ](#a7348be86da47ac034252a68949b21007)get\_var\_hash() \[1/2\]

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IVarHash::get\_var\_hash  ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*,    char \* *hash* ) const  pure virtual 

Get the hash of the variable data.

The hash of data for DVS objects is a checksum + the hex size of the internal arrays. The size of the has should be retrieved via [IVarHash::get\_var\_hash\_size()](#a85c3ade756029207e15b1c8de8cd5c1b "Get the size of the hash to use with IVarHash::get_var_hash()") to be compatible with future hash changes

Error Codes:

- DVS\_NONE: No error
- DVS\_INVALID\_HASH: Hash of data is invalid. There is a problem with the data
- DVS\_PARAM\_INVALID\_VAR: Bad (or null) variable object passed into method
- DVS\_PARAM\_INVALID\_VAR\_ID: Mesh chunk does not have data for var passed in.
- DVS\_PARAM\_NULL: All parameters are null. Method will do nothing.

Parameters \[in\]varvar of the variable data, not nullptr \[out\]hashreturns a null terminated string of size IVarHash::get\_hash\_size() to be filled if no error Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description 



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

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IVarHash::get\_var\_hash  ( uint32\_t *index*,    char \* *hash*,    [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) *type* = VAR\_TYPE::FLOAT ) const  pure virtual 

Get the hash of the variable data.

The hash of data for DVS objects is a checksum + the hex size of the internal arrays. The size of the has should be retrieved via [IVarHash::get\_var\_hash\_size()](#a85c3ade756029207e15b1c8de8cd5c1b "Get the size of the hash to use with IVarHash::get_var_hash()") to be compatible with future hash changes

Error Codes:

- DVS\_NONE: No error
- DVS\_INVALID\_HASH: Hash of data is invalid. There is a problem with the data
- DVS\_PARAM\_OUT\_OF\_BOUNDS: Index out of bounds of \[0, get\_num\_variables() on object this is called on\]
- DVS\_PARAM\_NULL: All parameters are null. Method will do nothing.

Parameters \[in\]indexthe index of the variable data (range 0, get\_num\_variables() on object this is on) \[out\]hashreturns a null terminated string of size IVarHash::get\_hash\_size() to be filled if no error \[in\]typethe enum type. By default, VAR\_TYPE::FLOAT Returnsdvs\_ret DVS\_NONE on no error, otherwise see method description 



<a id="a81cd99bbf69ccc0d50e8bcb7dd291046" name="a81cd99bbf69ccc0d50e8bcb7dd291046"></a>## [◆ ](#a81cd99bbf69ccc0d50e8bcb7dd291046)get\_var\_hash\_size() \[1/2\]

 virtual uint32\_t DVS::IVarHash::get\_var\_hash\_size  ( const [IVar](class_d_v_s_1_1_i_var.xhtml) \* *var*)  const  pure virtual 

Get the size of the hash to use with [IVarHash::get\_var\_hash()](#a17fff1548eb276edd326a0af08f6a7c4 "Get the hash of the variable data.")

Parameters \[in\]varthe variable definition to retrieve nodal variable data for Returnsuint32\_t the size of the hash from [IVarHash::get\_var\_hash()](#a17fff1548eb276edd326a0af08f6a7c4 "Get the hash of the variable data."), 0 if invalid var 



<a id="a85c3ade756029207e15b1c8de8cd5c1b" name="a85c3ade756029207e15b1c8de8cd5c1b"></a>## [◆ ](#a85c3ade756029207e15b1c8de8cd5c1b)get\_var\_hash\_size() \[2/2\]

 virtual uint32\_t DVS::IVarHash::get\_var\_hash\_size  ( uint32\_t *index*,    [VAR\_TYPE](dvs__var__interface_8h.xhtml#a84856d33cb231d1d87a603758b8b8066) *type* = VAR\_TYPE::FLOAT ) const  pure virtual 

Get the size of the hash to use with [IVarHash::get\_var\_hash()](#a17fff1548eb276edd326a0af08f6a7c4 "Get the hash of the variable data.")

Parameters indexindex of the variable data (range 0, get\_num\_variables() on object this is on) \[in\]typethe enum type. By default, VAR\_TYPE::FLOAT Returnsuint32\_t the size of the hash from [IVarHash::get\_var\_hash()](#a17fff1548eb276edd326a0af08f6a7c4 "Get the hash of the variable data."), 0 if invalid index 



---

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