DVS::IVarHash Class Reference
Last update: 16.07.2025#include <dvs_var_hash_interface.h>
Inheritance diagram for DVS::IVarHash:
Public Member Functions | |
| IVarHash ()=default | |
| virtual | ~IVarHash ()=default |
| IVarHash (IVarHash &&)=default | |
| IVarHash & | operator= (IVarHash &&)=default |
| IVarHash (const IVarHash &)=default | |
| IVarHash & | operator= (const IVarHash &)=default |
| virtual uint32_t | get_var_hash_size (uint32_t index, VAR_TYPE type=VAR_TYPE::FLOAT) const =0 |
| virtual uint32_t | get_var_hash_size (const IVar *var) const =0 |
| virtual dvs_ret | get_var_hash (uint32_t index, char *hash, VAR_TYPE type=VAR_TYPE::FLOAT) const =0 |
| virtual dvs_ret | get_var_hash (const IVar *var, char *hash) const =0 |
Detailed Description
Definition at line 39 of file dvs_var_hash_interface.h.
Member Function Documentation
◆ get_var_hash() [1/2]
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() 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] var var of the variable data, not nullptr [out] hash returns a null terminated string of size IVarHash::get_hash_size() to be filled if no error
- Returns
- dvs_ret DVS_NONE on no error, otherwise see method description
◆ get_var_hash() [2/2]
|
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() 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] index the index of the variable data (range 0, get_num_variables() on object this is on) [out] hash returns a null terminated string of size IVarHash::get_hash_size() to be filled if no error [in] type the enum type. By default, VAR_TYPE::FLOAT
- Returns
- dvs_ret DVS_NONE on no error, otherwise see method description
◆ get_var_hash_size() [1/2]
|
pure virtual |
Get the size of the hash to use with IVarHash::get_var_hash()
- Parameters
-
[in] var the variable definition to retrieve nodal variable data for
- Returns
- uint32_t the size of the hash from IVarHash::get_var_hash(), 0 if invalid var
◆ get_var_hash_size() [2/2]
|
pure virtual |
Get the size of the hash to use with IVarHash::get_var_hash()
- Parameters
-
index index of the variable data (range 0, get_num_variables() on object this is on) [in] type the enum type. By default, VAR_TYPE::FLOAT
- Returns
- uint32_t the size of the hash from IVarHash::get_var_hash(), 0 if invalid index
The documentation for this class was generated from the following file:
- D:/Product-src/ensight/user_defined_src/readers/dvs/include/dvs_var_hash_interface.h
