Post-processing tools 2023 R2

DVS::IVarHash Class Reference

Last update: 17.04.2023

Interface to get variable hash information from DVS objects. More...

#include <dvs_var_hash_interface.h>

Inheritance diagram for DVS::IVarHash:
DVS::IElementBlockDVS::IMeshChunk

Public Member Functions

 IVarHash ()=default
 default
 
virtual ~IVarHash ()=default
 default
 
 IVarHash (IVarHash &&)=default
 default
 
IVarHash & operator= (IVarHash &&)=default
 default
 
 IVarHash (const IVarHash &)=default
 support copying
 
IVarHash & operator= (const IVarHash &)=default
 default
 
virtual uint32_t get_var_hash_size (uint32_t index) const =0
 Get the size of the hash to use with IVarHash::get_var_hash() More...
 
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() More...
 
virtual dvs_ret get_var_hash (uint32_t index, char *hash) const =0
 Get the hash of the variable data. More...
 
virtual dvs_ret get_var_hash (const IVar *var, char *hash) const =0
 Get the hash of the variable data. More...
 

Detailed Description

Interface to get variable hash information from DVS objects.

Definition at line 39 of file dvs_var_hash_interface.h.

Member Function Documentation

◆ get_var_hash() [1/2]

virtual dvs_ret DVS::IVarHash::get_var_hash ( const IVar *  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() 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
Returns
dvs_ret DVS_NONE on no error, otherwise see method description

◆ get_var_hash() [2/2]

virtual dvs_ret DVS::IVarHash::get_var_hash ( uint32_t  index,
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() 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
Returns
dvs_ret DVS_NONE on no error, otherwise see method description

◆ get_var_hash_size() [1/2]

virtual uint32_t DVS::IVarHash::get_var_hash_size ( const IVar *  var) const
pure virtual

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

Parameters
[in]varthe 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]

virtual uint32_t DVS::IVarHash::get_var_hash_size ( uint32_t  index) const
pure virtual

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

Parameters
indexindex of the variable data (range 0, get_num_variables() on object this is on)
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:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/user_defined_src/readers/dvs/include/dvs_var_hash_interface.h

Connect with Ansys