## On this page

  

 

 # dynamic\_visualization\_store\_api

 Last update: 16.07.2025 

[Go to the documentation of this file.](dynamic__visualization__store__api_8h.xhtml)<a id="l00001" name="l00001"></a> 1/\* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00002" name="l00002"></a> 2 \* Copyright 2017-2024 ANSYS, Inc.

<a id="l00003" name="l00003"></a> 3 \* All Rights Reserved.

<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\#ifndef \_DYNAMIC\_VISUALIZATION\_STORE\_API\_

<a id="l00017" name="l00017"></a> 17\#define \_DYNAMIC\_VISUALIZATION\_STORE\_API\_

<a id="l00018" name="l00018"></a> 18 

<a id="l00060" name="l00060"></a> 60\#include &lt;stdint.h&gt;

<a id="l00061" name="l00061"></a> 61\#include "[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)"

<a id="l00062" name="l00062"></a> 62\#include "[dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml)"

<a id="l00063" name="l00063"></a> 63\#include "[dynamic\_visualization\_store\_version.h](dynamic__visualization__store__version_8h.xhtml)"

<a id="l00064" name="l00064"></a> 64 

<a id="l00065" name="l00065"></a> 65\#include "include/dvs\_import\_export.h"

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

<a id="l00067" name="l00067"></a> 67\#ifdef \_\_cplusplus

<a id="l00068" name="l00068"></a> 68extern "C"

<a id="l00069" name="l00069"></a> 69{

<a id="l00070" name="l00070"></a> 70\#endif /\* \_\_cplusplus \*/

<a id="l00071" name="l00071"></a> 71 

<a id="l00076" name="l00076"></a>[ 76](structdvs__part__info.xhtml)struct [dvs\_part\_info](structdvs__part__info.xhtml)

<a id="l00077" name="l00077"></a> 77{

<a id="l00078" name="l00078"></a>[ 78](structdvs__part__info.xhtml#ab4e6fd830f27fdfa60c7bf6c2c137695) uint32_t [\_id](structdvs__part__info.xhtml#ab4e6fd830f27fdfa60c7bf6c2c137695); 

<a id="l00079" name="l00079"></a>[ 79](structdvs__part__info.xhtml#aa3ef86ed8620b0419f05e4e255dd01fb) char* [\_name](structdvs__part__info.xhtml#aa3ef86ed8620b0419f05e4e255dd01fb); 

<a id="l00080" name="l00080"></a>[ 80](structdvs__part__info.xhtml#ab458569530b84c8a2403b2610af98989) uint8_t [\_structured](structdvs__part__info.xhtml#ab458569530b84c8a2403b2610af98989); 

<a id="l00081" name="l00081"></a>[ 81](structdvs__part__info.xhtml#af688078624a42e9ab53d3c194e2861c3) uint8_t [\_chunking](structdvs__part__info.xhtml#af688078624a42e9ab53d3c194e2861c3); 

<a id="l00082" name="l00082"></a>[ 82](structdvs__part__info.xhtml#adb36557a49efa5373a258141dd472385) uint32_t [\_metadata\_num\_pairs](structdvs__part__info.xhtml#adb36557a49efa5373a258141dd472385); 

<a id="l00083" name="l00083"></a>[ 83](structdvs__part__info.xhtml#aef3ab830a0bfcab49d9cbed978e315c2) char** [\_metadata\_keys](structdvs__part__info.xhtml#aef3ab830a0bfcab49d9cbed978e315c2); 

<a id="l00084" name="l00084"></a>[ 84](structdvs__part__info.xhtml#a59c04a77c663b68008a1f69b62574337) char** [\_metadata\_vals](structdvs__part__info.xhtml#a59c04a77c663b68008a1f69b62574337); 

<a id="l00085" name="l00085"></a> 85};

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

<a id="l00091" name="l00091"></a>[ 91](structdvs__var__info.xhtml)struct [dvs\_var\_info](structdvs__var__info.xhtml)

<a id="l00092" name="l00092"></a> 92{

<a id="l00093" name="l00093"></a>[ 93](structdvs__var__info.xhtml#abcef03f7b1e419ae39c7511de2385a9b) uint32_t [\_id](structdvs__var__info.xhtml#abcef03f7b1e419ae39c7511de2385a9b); 

<a id="l00094" name="l00094"></a>[ 94](structdvs__var__info.xhtml#ad1b4aeadeb75d6ab2a446fef37f11d0a) char* [\_name](structdvs__var__info.xhtml#ad1b4aeadeb75d6ab2a446fef37f11d0a); 

<a id="l00095" name="l00095"></a>[ 95](structdvs__var__info.xhtml#a721f90cd12b7e98cf0d2fcf99ed9c7a9) enum [dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) [\_type](structdvs__var__info.xhtml#a721f90cd12b7e98cf0d2fcf99ed9c7a9); 

<a id="l00096" name="l00096"></a>[ 96](structdvs__var__info.xhtml#abfd6a4461939e798ebdc5d6714a4558f) enum [dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491) [\_location](structdvs__var__info.xhtml#abfd6a4461939e798ebdc5d6714a4558f); 

<a id="l00097" name="l00097"></a>[ 97](structdvs__var__info.xhtml#a3d7cdb8a063eaf6c94f95f3b589c8624) char* [\_unit](structdvs__var__info.xhtml#a3d7cdb8a063eaf6c94f95f3b589c8624); 

<a id="l00098" name="l00098"></a>[ 98](structdvs__var__info.xhtml#a262ba1165d1929418e03a2a250774525) char* [\_unit\_label](structdvs__var__info.xhtml#a262ba1165d1929418e03a2a250774525); 

<a id="l00099" name="l00099"></a>[ 99](structdvs__var__info.xhtml#a9f99fd8ad9d004f44939c830747ebfc8) uint32_t [\_metadata\_num\_pairs](structdvs__var__info.xhtml#a9f99fd8ad9d004f44939c830747ebfc8); 

<a id="l00100" name="l00100"></a>[ 100](structdvs__var__info.xhtml#a9c656726edeeb5c0cf5b9a42f870b3a2) char** [\_metadata\_keys](structdvs__var__info.xhtml#a9c656726edeeb5c0cf5b9a42f870b3a2); 

<a id="l00101" name="l00101"></a>[ 101](structdvs__var__info.xhtml#abe0afbff61a368336c7750c831a3c056) char** [\_metadata\_vals](structdvs__var__info.xhtml#abe0afbff61a368336c7750c831a3c056); 

<a id="l00102" name="l00102"></a> 102};

<a id="l00103" name="l00103"></a> 103 

<a id="l00108" name="l00108"></a>[ 108](structdvs__plot__info.xhtml)struct [dvs\_plot\_info](structdvs__plot__info.xhtml)

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

<a id="l00110" name="l00110"></a>[ 110](structdvs__plot__info.xhtml#a7721b22bb882c90e84d68979a748daf3) uint32_t [\_id](structdvs__plot__info.xhtml#a7721b22bb882c90e84d68979a748daf3); 

<a id="l00111" name="l00111"></a>[ 111](structdvs__plot__info.xhtml#a00c93696be3b5f9f3c2288daf9975f19) char* [\_name](structdvs__plot__info.xhtml#a00c93696be3b5f9f3c2288daf9975f19); 

<a id="l00112" name="l00112"></a>[ 112](structdvs__plot__info.xhtml#a6cdeb2ede603f7aa96c515e2691e11a0) char* [\_x\_axis\_title](structdvs__plot__info.xhtml#a6cdeb2ede603f7aa96c515e2691e11a0); 

<a id="l00113" name="l00113"></a>[ 113](structdvs__plot__info.xhtml#aac4a7335b4bcda68808eea67e280346b) char* [\_x\_axis\_units](structdvs__plot__info.xhtml#aac4a7335b4bcda68808eea67e280346b); 

<a id="l00114" name="l00114"></a>[ 114](structdvs__plot__info.xhtml#aae1ce6d97a55e3da272f552508f61e11) char* [\_y\_axis\_title](structdvs__plot__info.xhtml#aae1ce6d97a55e3da272f552508f61e11); 

<a id="l00115" name="l00115"></a>[ 115](structdvs__plot__info.xhtml#a368da9b3c7dd1b8b8b37daed5d97554d) char* [\_y\_axis\_units](structdvs__plot__info.xhtml#a368da9b3c7dd1b8b8b37daed5d97554d); 

<a id="l00116" name="l00116"></a>[ 116](structdvs__plot__info.xhtml#a2d0bc2ca11580a27d9a8637a848d6e14) uint32_t [\_metadata\_num\_pairs](structdvs__plot__info.xhtml#a2d0bc2ca11580a27d9a8637a848d6e14); 

<a id="l00117" name="l00117"></a>[ 117](structdvs__plot__info.xhtml#a6182c10a62849ada795123fd6707d612) char** [\_metadata\_keys](structdvs__plot__info.xhtml#a6182c10a62849ada795123fd6707d612); 

<a id="l00118" name="l00118"></a>[ 118](structdvs__plot__info.xhtml#a467b2e79ceb431c9358423647de59699) char** [\_metadata\_vals](structdvs__plot__info.xhtml#a467b2e79ceb431c9358423647de59699); 

<a id="l00119" name="l00119"></a> 119};

<a id="l00120" name="l00120"></a> 120 

<a id="l00133" name="l00133"></a>[ 133](dynamic__visualization__store__api_8h.xhtml#ab96812d4412a9af10e7e7924c572a7c9)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_connect](dynamic__visualization__store__api_8h.xhtml#ab96812d4412a9af10e7e7924c572a7c9)(int32_t server_id, enum [dvs\_client\_flags](dynamic__visualization__store__enums_8h.xhtml#aec8cbac60b9cafe5d1c0ad6593f05e9f) flags, const char* secret, int32_t* session_id);

<a id="l00134" name="l00134"></a> 134 

<a id="l00135" name="l00135"></a> 135// Function definition for logging of client messages

<a id="l00136" name="l00136"></a> 136// First param is for user defined data

<a id="l00137" name="l00137"></a> 137 

<a id="l00143" name="l00143"></a>[ 143](dynamic__visualization__store__api_8h.xhtml#a80c7c60e9cd61fcc0a0aacac09d66947)typedef void (*[dvs\_log\_func](dynamic__visualization__store__api_8h.xhtml#a80c7c60e9cd61fcc0a0aacac09d66947))(void*, const char*);

<a id="l00144" name="l00144"></a> 144 

<a id="l00156" name="l00156"></a>[ 156](dynamic__visualization__store__api_8h.xhtml#ae57cf8cf0b10421aace6df32a98c60ae)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_register\_log\_func](dynamic__visualization__store__api_8h.xhtml#ae57cf8cf0b10421aace6df32a98c60ae)(int32_t session_id, void* user_data, [dvs\_log\_func](dynamic__visualization__store__api_8h.xhtml#a80c7c60e9cd61fcc0a0aacac09d66947) func, enum [dvs\_log\_flags](dynamic__visualization__store__enums_8h.xhtml#a9bca12092877a90e6c497994093a8609) flags);

<a id="l00157" name="l00157"></a> 157 

<a id="l00169" name="l00169"></a>[ 169](dynamic__visualization__store__api_8h.xhtml#ab8e85aad9b7ec78976db76017803a6b6)DVS_DLL_EXPORT const char* [dvs\_get\_version](dynamic__visualization__store__api_8h.xhtml#ab8e85aad9b7ec78976db76017803a6b6)();

<a id="l00170" name="l00170"></a> 170 

<a id="l00182" name="l00182"></a>[ 182](dynamic__visualization__store__api_8h.xhtml#a3744408f15cd4a36d19880d24d442a0d)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_begin\_init](dynamic__visualization__store__api_8h.xhtml#a3744408f15cd4a36d19880d24d442a0d)(int32_t session_id, const char* dataset_name, uint32_t current_rank, uint32_t total_ranks, uint32_t num_chunks);

<a id="l00183" name="l00183"></a> 183 

<a id="l00193" name="l00193"></a>[ 193](dynamic__visualization__store__api_8h.xhtml#a14b52ceff846429259cab42ee11579f0)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_set\_unit\_system](dynamic__visualization__store__api_8h.xhtml#a14b52ceff846429259cab42ee11579f0)(int32_t session_id, const char* system);

<a id="l00194" name="l00194"></a> 194 

<a id="l00213" name="l00213"></a>[ 213](dynamic__visualization__store__api_8h.xhtml#ac5c67fdc3806bf89eebbe49e6daea5c2)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_add\_metadata](dynamic__visualization__store__api_8h.xhtml#ac5c67fdc3806bf89eebbe49e6daea5c2)(int32_t session_id, const char* const metadata_keys[], const char* const metadata_vals[], uint32_t num_metadata_pairs);

<a id="l00214" name="l00214"></a> 214 

<a id="l00225" name="l00225"></a>[ 225](dynamic__visualization__store__api_8h.xhtml#a4e8a904ae19fd7f2b0c300543bc42576)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_add\_part\_info](dynamic__visualization__store__api_8h.xhtml#a4e8a904ae19fd7f2b0c300543bc42576)(int32_t session_id, const struct [dvs\_part\_info](structdvs__part__info.xhtml)* parts, uint32_t num_parts);

<a id="l00226" name="l00226"></a> 226 

<a id="l00237" name="l00237"></a>[ 237](dynamic__visualization__store__api_8h.xhtml#a0b9bbed0db0a5f3e91af8a02aed48e1e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_add\_var\_info](dynamic__visualization__store__api_8h.xhtml#a0b9bbed0db0a5f3e91af8a02aed48e1e)(int32_t session_id, const struct [dvs\_var\_info](structdvs__var__info.xhtml)* vars, uint32_t num_vars);

<a id="l00238" name="l00238"></a> 238 

<a id="l00249" name="l00249"></a>[ 249](dynamic__visualization__store__api_8h.xhtml#afe298f932fd909b7caabd6f430489b16)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_add\_plot\_info](dynamic__visualization__store__api_8h.xhtml#afe298f932fd909b7caabd6f430489b16)(int32_t session_id, const struct [dvs\_plot\_info](structdvs__plot__info.xhtml)* plots, uint32_t num_plots);

<a id="l00250" name="l00250"></a> 250 

<a id="l00259" name="l00259"></a>[ 259](dynamic__visualization__store__api_8h.xhtml#a5a6cd68f61a53bce6780d3ef95038277)DVS_DLL_EXPORT uint32_t [dvs\_get\_num\_part\_info](dynamic__visualization__store__api_8h.xhtml#a5a6cd68f61a53bce6780d3ef95038277)(int32_t session_id);

<a id="l00260" name="l00260"></a> 260 

<a id="l00269" name="l00269"></a>[ 269](dynamic__visualization__store__api_8h.xhtml#ad75625cedecbcd365c868c9893c6c2d8)DVS_DLL_EXPORT uint32_t [dvs\_get\_num\_var\_info](dynamic__visualization__store__api_8h.xhtml#ad75625cedecbcd365c868c9893c6c2d8)(int32_t session_id);

<a id="l00270" name="l00270"></a> 270 

<a id="l00271" name="l00271"></a> 271 

<a id="l00280" name="l00280"></a>[ 280](dynamic__visualization__store__api_8h.xhtml#aa44dcb6596c7833d2b9fe2a0435bb4c4)DVS_DLL_EXPORT uint32_t [dvs\_get\_num\_plot\_info](dynamic__visualization__store__api_8h.xhtml#aa44dcb6596c7833d2b9fe2a0435bb4c4)(int32_t session_id);

<a id="l00281" name="l00281"></a> 281 

<a id="l00291" name="l00291"></a>[ 291](dynamic__visualization__store__api_8h.xhtml#a5b5a64e37bd6830f518947e7a0f7985e)DVS_DLL_EXPORT const struct [dvs\_part\_info](structdvs__part__info.xhtml)* [dvs\_get\_part\_info](dynamic__visualization__store__api_8h.xhtml#a5b5a64e37bd6830f518947e7a0f7985e)(int32_t session_id, uint32_t index);

<a id="l00292" name="l00292"></a> 292 

<a id="l00308" name="l00308"></a>[ 308](dynamic__visualization__store__api_8h.xhtml#aefeb5e79919700a670799d9f3e8f0e2c)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_get\_part\_id](dynamic__visualization__store__api_8h.xhtml#aefeb5e79919700a670799d9f3e8f0e2c)(int32_t session_id, const char* name, uint32_t* id);

<a id="l00309" name="l00309"></a> 309 

<a id="l00319" name="l00319"></a>[ 319](dynamic__visualization__store__api_8h.xhtml#a8992f4a5e6c36c5e4da67968b170313c)DVS_DLL_EXPORT const struct [dvs\_var\_info](structdvs__var__info.xhtml)* [dvs\_get\_var\_info](dynamic__visualization__store__api_8h.xhtml#a8992f4a5e6c36c5e4da67968b170313c)(int32_t session_id, uint32_t index);

<a id="l00320" name="l00320"></a> 320 

<a id="l00336" name="l00336"></a>[ 336](dynamic__visualization__store__api_8h.xhtml#a355c95f11b171a15755f748da3349e67)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_get\_var\_id](dynamic__visualization__store__api_8h.xhtml#a355c95f11b171a15755f748da3349e67)(int32_t session_id, const char* name, uint32_t* id);

<a id="l00337" name="l00337"></a> 337 

<a id="l00347" name="l00347"></a>[ 347](dynamic__visualization__store__api_8h.xhtml#ac3fca7087e8b4366686cef98a95f241f)DVS_DLL_EXPORT const struct [dvs\_plot\_info](structdvs__plot__info.xhtml)* [dvs\_get\_plot\_info](dynamic__visualization__store__api_8h.xhtml#ac3fca7087e8b4366686cef98a95f241f)(int32_t session_id, uint32_t index);

<a id="l00348" name="l00348"></a> 348 

<a id="l00364" name="l00364"></a>[ 364](dynamic__visualization__store__api_8h.xhtml#a3ae625f138573f6fa9904f0609ca1eb1)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_get\_plot\_id](dynamic__visualization__store__api_8h.xhtml#a3ae625f138573f6fa9904f0609ca1eb1)(int32_t session_id, const char* name, uint32_t* id);

<a id="l00365" name="l00365"></a> 365 

<a id="l00374" name="l00374"></a>[ 374](dynamic__visualization__store__api_8h.xhtml#ac4d82529053c964b76bd42916c51835e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_end\_init](dynamic__visualization__store__api_8h.xhtml#ac4d82529053c964b76bd42916c51835e)(int32_t session_id);

<a id="l00375" name="l00375"></a> 375 

<a id="l00386" name="l00386"></a>[ 386](dynamic__visualization__store__api_8h.xhtml#aaac598618be531e8aa2b72ad41e18537)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_begin\_update](dynamic__visualization__store__api_8h.xhtml#aaac598618be531e8aa2b72ad41e18537)(int32_t session_id, uint32_t update_num, uint32_t rank, uint32_t chunk, float time);

<a id="l00387" name="l00387"></a> 387 

<a id="l00402" name="l00402"></a>[ 402](dynamic__visualization__store__api_8h.xhtml#af2223790199210c6fd1f5ac5ade6c60a)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_copy\_previous\_part](dynamic__visualization__store__api_8h.xhtml#af2223790199210c6fd1f5ac5ade6c60a)(int32_t session_id, uint32_t part_id, const char* options);

<a id="l00403" name="l00403"></a> 403 

<a id="l00415" name="l00415"></a>[ 415](dynamic__visualization__store__api_8h.xhtml#a7fdc956a0712ef2a60195fa013e59222)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_nodes](dynamic__visualization__store__api_8h.xhtml#a7fdc956a0712ef2a60195fa013e59222)(int32_t session_id, uint32_t part_id, const float* x, const float* y, const float* z, uint32_t num_values);

<a id="l00416" name="l00416"></a> 416 

<a id="l00458" name="l00458"></a>[ 458](dynamic__visualization__store__api_8h.xhtml#a0d0312c5143eb8de2e08a903c929d8c3)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_nodes\_parallelepiped](dynamic__visualization__store__api_8h.xhtml#a0d0312c5143eb8de2e08a903c929d8c3)

<a id="l00459" name="l00459"></a> 459(

<a id="l00460" name="l00460"></a> 460 int32_t session_id,

<a id="l00461" name="l00461"></a> 461 uint32_t part_id,

<a id="l00462" name="l00462"></a> 462 const uint32_t global_ijk_max[3],

<a id="l00463" name="l00463"></a> 463 const uint32_t local_ijk_min[3],

<a id="l00464" name="l00464"></a> 464 const uint32_t local_ijk_max[3],

<a id="l00465" name="l00465"></a> 465 const float origin[3],

<a id="l00466" name="l00466"></a> 466 const float dir_i[3],

<a id="l00467" name="l00467"></a> 467 const float dir_j[3],

<a id="l00468" name="l00468"></a> 468 const float dir_k[3],

<a id="l00469" name="l00469"></a> 469 const float* i_vals,

<a id="l00470" name="l00470"></a> 470 const float* j_vals,

<a id="l00471" name="l00471"></a> 471 const float* k_vals

<a id="l00472" name="l00472"></a> 472);

<a id="l00473" name="l00473"></a> 473 

<a id="l00503" name="l00503"></a>[ 503](dynamic__visualization__store__api_8h.xhtml#af69daaa5a2ac63f7ce31a2e8e3d66332)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_nodes\_curvilinear](dynamic__visualization__store__api_8h.xhtml#af69daaa5a2ac63f7ce31a2e8e3d66332)

<a id="l00504" name="l00504"></a> 504(

<a id="l00505" name="l00505"></a> 505 int32_t session_id,

<a id="l00506" name="l00506"></a> 506 uint32_t part_id,

<a id="l00507" name="l00507"></a> 507 const uint32_t global_ijk_max[3],

<a id="l00508" name="l00508"></a> 508 const uint32_t local_ijk_min[3],

<a id="l00509" name="l00509"></a> 509 const uint32_t local_ijk_max[3],

<a id="l00510" name="l00510"></a> 510 const float* x_vals,

<a id="l00511" name="l00511"></a> 511 const float* y_vals,

<a id="l00512" name="l00512"></a> 512 const float* z_vals

<a id="l00513" name="l00513"></a> 513);

<a id="l00514" name="l00514"></a> 514 

<a id="l00529" name="l00529"></a>[ 529](dynamic__visualization__store__api_8h.xhtml#a05061077e83272567bbc43367c0b8e74)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_elements](dynamic__visualization__store__api_8h.xhtml#a05061077e83272567bbc43367c0b8e74)(int32_t session_id, uint32_t part_id, enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type, const uint32_t* indices, uint32_t num_indices);

<a id="l00530" name="l00530"></a> 530 

<a id="l00549" name="l00549"></a>[ 549](dynamic__visualization__store__api_8h.xhtml#a763afb059b0301ba18fefe3cd126ce79)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_elements\_polygon](dynamic__visualization__store__api_8h.xhtml#a763afb059b0301ba18fefe3cd126ce79)

<a id="l00550" name="l00550"></a> 550(

<a id="l00551" name="l00551"></a> 551 int32_t session_id,

<a id="l00552" name="l00552"></a> 552 uint32_t part_id,

<a id="l00553" name="l00553"></a> 553 enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type,

<a id="l00554" name="l00554"></a> 554 const uint32_t* nodes_per_polygon,

<a id="l00555" name="l00555"></a> 555 uint32_t nodes_per_polygon_size,

<a id="l00556" name="l00556"></a> 556 const uint32_t* indices,

<a id="l00557" name="l00557"></a> 557 uint32_t indices_size

<a id="l00558" name="l00558"></a> 558);

<a id="l00559" name="l00559"></a> 559 

<a id="l00574" name="l00574"></a>[ 574](dynamic__visualization__store__api_8h.xhtml#aff070e9087ba34f41200ff0cd1d3002e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_elements\_polyhedral](dynamic__visualization__store__api_8h.xhtml#aff070e9087ba34f41200ff0cd1d3002e)

<a id="l00575" name="l00575"></a> 575(

<a id="l00576" name="l00576"></a> 576 int32_t session_id,

<a id="l00577" name="l00577"></a> 577 uint32_t part_id,

<a id="l00578" name="l00578"></a> 578 enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type,

<a id="l00579" name="l00579"></a> 579 const uint32_t* faces_per_element,

<a id="l00580" name="l00580"></a> 580 uint32_t faces_per_element_size,

<a id="l00581" name="l00581"></a> 581 const uint32_t* nodes_per_face,

<a id="l00582" name="l00582"></a> 582 uint32_t nodes_per_face_size,

<a id="l00583" name="l00583"></a> 583 const uint32_t* indices,

<a id="l00584" name="l00584"></a> 584 uint32_t indices_size

<a id="l00585" name="l00585"></a> 585);

<a id="l00586" name="l00586"></a> 586 

<a id="l00595" name="l00595"></a>[ 595](dynamic__visualization__store__api_8h.xhtml#ad97de401448e85da8cb13d3e45cfb227)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_case\_scalar](dynamic__visualization__store__api_8h.xhtml#ad97de401448e85da8cb13d3e45cfb227)(int32_t session_id, uint32_t var_id, float scalar);

<a id="l00596" name="l00596"></a> 596 

<a id="l00606" name="l00606"></a>[ 606](dynamic__visualization__store__api_8h.xhtml#a853ed7ef2608619b82dd51055cee3f60)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_part\_scalar](dynamic__visualization__store__api_8h.xhtml#a853ed7ef2608619b82dd51055cee3f60)(int32_t session_id, uint32_t var_id, uint32_t part_id, float scalar);

<a id="l00607" name="l00607"></a> 607 

<a id="l00616" name="l00616"></a>[ 616](dynamic__visualization__store__api_8h.xhtml#ab4e0ac12018e08551d6b8121971fea7e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_case\_vector](dynamic__visualization__store__api_8h.xhtml#ab4e0ac12018e08551d6b8121971fea7e)(int32_t session_id, uint32_t var_id, const float* vec);

<a id="l00617" name="l00617"></a> 617 

<a id="l00627" name="l00627"></a>[ 627](dynamic__visualization__store__api_8h.xhtml#a0b8da4c016b09b93b3fcf71afe384b21)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_part\_vector](dynamic__visualization__store__api_8h.xhtml#a0b8da4c016b09b93b3fcf71afe384b21)(int32_t session_id, uint32_t var_id, uint32_t part_id, const float* vec);

<a id="l00628" name="l00628"></a> 628 

<a id="l00640" name="l00640"></a>[ 640](dynamic__visualization__store__api_8h.xhtml#aae3c0a5237c193d05266fba6e6798a4c)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_element\_scalar](dynamic__visualization__store__api_8h.xhtml#aae3c0a5237c193d05266fba6e6798a4c)(int32_t session_id, uint32_t var_id, uint32_t part_id, enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type, const float* scalars, uint32_t num_vals);

<a id="l00641" name="l00641"></a> 641 

<a id="l00653" name="l00653"></a>[ 653](dynamic__visualization__store__api_8h.xhtml#a008017a6bb9e8c8488e392d3cf58f7ad)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_element\_scalar\_int64](dynamic__visualization__store__api_8h.xhtml#a008017a6bb9e8c8488e392d3cf58f7ad)(int32_t session_id, uint32_t var_id, uint32_t part_id, enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type, const int64_t* scalars, uint32_t num_vals);

<a id="l00654" name="l00654"></a> 654 

<a id="l00665" name="l00665"></a>[ 665](dynamic__visualization__store__api_8h.xhtml#aea17a7bbdc6ac8c2cdd4e6c35c1a8578)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_node\_scalar](dynamic__visualization__store__api_8h.xhtml#aea17a7bbdc6ac8c2cdd4e6c35c1a8578)(int32_t session_id, uint32_t var_id, uint32_t part_id, const float* scalars, uint32_t num_vals);

<a id="l00666" name="l00666"></a> 666 

<a id="l00677" name="l00677"></a>[ 677](dynamic__visualization__store__api_8h.xhtml#a7c130a702347b1baa7e884303f3ce9d5)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_node\_scalar\_int64](dynamic__visualization__store__api_8h.xhtml#a7c130a702347b1baa7e884303f3ce9d5)(int32_t session_id, uint32_t var_id, uint32_t part_id, const int64_t* scalars, uint32_t num_vals);

<a id="l00678" name="l00678"></a> 678 

<a id="l00693" name="l00693"></a>[ 693](dynamic__visualization__store__api_8h.xhtml#af3cd5ecfd626ca40b1273634734f38d5)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_element\_vector](dynamic__visualization__store__api_8h.xhtml#af3cd5ecfd626ca40b1273634734f38d5)(int32_t session_id, uint32_t var_id, uint32_t part_id, enum [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type, const float* values, uint32_t num_values);

<a id="l00694" name="l00694"></a> 694 

<a id="l00708" name="l00708"></a>[ 708](dynamic__visualization__store__api_8h.xhtml#a9086155711ed76c6141bdde2291f140a)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_var\_node\_vector](dynamic__visualization__store__api_8h.xhtml#a9086155711ed76c6141bdde2291f140a)(int32_t session_id, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values);

<a id="l00709" name="l00709"></a> 709 

<a id="l00722" name="l00722"></a>[ 722](dynamic__visualization__store__api_8h.xhtml#a433ce5100e551dca71dee92b0afe1563)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_update\_plot](dynamic__visualization__store__api_8h.xhtml#a433ce5100e551dca71dee92b0afe1563)(int32_t session_id, uint32_t plot_id, const float* x_values, const float* y_values, uint32_t num_values);

<a id="l00723" name="l00723"></a> 723 

<a id="l00730" name="l00730"></a>[ 730](dynamic__visualization__store__api_8h.xhtml#ae75177bf47fcb28313e79840bf778c75)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_end\_update](dynamic__visualization__store__api_8h.xhtml#ae75177bf47fcb28313e79840bf778c75)(int32_t session_id);

<a id="l00731" name="l00731"></a> 731 

<a id="l00753" name="l00753"></a>[ 753](dynamic__visualization__store__api_8h.xhtml#a5237ada583b0cb7817d12d1135f9349e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_delete\_item](dynamic__visualization__store__api_8h.xhtml#a5237ada583b0cb7817d12d1135f9349e)(int32_t session_id, uint32_t update_num, uint32_t rank, const char* filter);

<a id="l00754" name="l00754"></a> 754 

<a id="l00760" name="l00760"></a>[ 760](dynamic__visualization__store__api_8h.xhtml#a345e9b656b994a3e1677b354077b2fff)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_print\_stats](dynamic__visualization__store__api_8h.xhtml#a345e9b656b994a3e1677b354077b2fff)(int32_t session_id);

<a id="l00761" name="l00761"></a> 761 

<a id="l00768" name="l00768"></a>[ 768](dynamic__visualization__store__api_8h.xhtml#abf84206bdff4c0d6f00ada37f6eadf55)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_session\_shutdown](dynamic__visualization__store__api_8h.xhtml#abf84206bdff4c0d6f00ada37f6eadf55)(int32_t session_id);

<a id="l00769" name="l00769"></a> 769 

<a id="l00777" name="l00777"></a>[ 777](dynamic__visualization__store__api_8h.xhtml#adc2aa26177a1b4a487b3c8f3f7b7b23d)DVS_DLL_EXPORT void [dvs\_session\_shutdown\_all](dynamic__visualization__store__api_8h.xhtml#adc2aa26177a1b4a487b3c8f3f7b7b23d)();

<a id="l00778" name="l00778"></a> 778 

<a id="l00783" name="l00783"></a>[ 783](dynamic__visualization__store__api_8h.xhtml#a815bb1d2251e35e3bfd3c44a4a338052)DVS_DLL_EXPORT void [dvs\_shutdown](dynamic__visualization__store__api_8h.xhtml#a815bb1d2251e35e3bfd3c44a4a338052)();

<a id="l00784" name="l00784"></a> 784 

<a id="l00792" name="l00792"></a>[ 792](dynamic__visualization__store__api_8h.xhtml#a06196ff56fe7f270172239c1be4ce0cd)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_create](dynamic__visualization__store__api_8h.xhtml#a06196ff56fe7f270172239c1be4ce0cd)(const char* server_uri, int32_t* server_id);

<a id="l00793" name="l00793"></a> 793 

<a id="l00806" name="l00806"></a>[ 806](dynamic__visualization__store__api_8h.xhtml#ae8abdb8455cea44bbd9f509c1a063516)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_set\_option](dynamic__visualization__store__api_8h.xhtml#ae8abdb8455cea44bbd9f509c1a063516)(int32_t server_id, const char* key, const char* value);

<a id="l00807" name="l00807"></a> 807 

<a id="l00821" name="l00821"></a>[ 821](dynamic__visualization__store__api_8h.xhtml#aa5722a5316ee73bdd998c9a327e8cb3d)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_start](dynamic__visualization__store__api_8h.xhtml#aa5722a5316ee73bdd998c9a327e8cb3d)(int32_t server_id, uint32_t server_number, uint32_t local_ranks);

<a id="l00822" name="l00822"></a> 822 

<a id="l00830" name="l00830"></a>[ 830](dynamic__visualization__store__api_8h.xhtml#a996a1d0e1696ad7f991e44357d78a422)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_started](dynamic__visualization__store__api_8h.xhtml#a996a1d0e1696ad7f991e44357d78a422)(int32_t server_id, uint32_t* running);

<a id="l00831" name="l00831"></a> 831 

<a id="l00840" name="l00840"></a>[ 840](dynamic__visualization__store__api_8h.xhtml#adeb64f5db63b08a79f2a59a85c5d9683) DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_timestep\_count](dynamic__visualization__store__api_8h.xhtml#adeb64f5db63b08a79f2a59a85c5d9683)(int32_t server_id, uint32_t* num_pending, uint32_t* num_complete);

<a id="l00841" name="l00841"></a> 841 

<a id="l00848" name="l00848"></a>[ 848](dynamic__visualization__store__api_8h.xhtml#ad16ba277108c7187b0a11f461b1477ca)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_shutdown](dynamic__visualization__store__api_8h.xhtml#ad16ba277108c7187b0a11f461b1477ca)(int32_t server_id);

<a id="l00849" name="l00849"></a> 849 

<a id="l00854" name="l00854"></a>[ 854](dynamic__visualization__store__api_8h.xhtml#ac16a3c06bb1968ddba06d83f5e2a1f56)DVS_DLL_EXPORT void [dvs\_server\_shutdown\_all](dynamic__visualization__store__api_8h.xhtml#ac16a3c06bb1968ddba06d83f5e2a1f56)();

<a id="l00855" name="l00855"></a> 855 

<a id="l00874" name="l00874"></a>[ 874](dynamic__visualization__store__api_8h.xhtml#a11887bd000ddab30ababc765e244b094)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_server\_get\_uri](dynamic__visualization__store__api_8h.xhtml#a11887bd000ddab30ababc765e244b094)(int32_t server_id, char* uri, uint32_t* size);

<a id="l00875" name="l00875"></a> 875 

<a id="l00889" name="l00889"></a>[ 889](dynamic__visualization__store__api_8h.xhtml#ab768f6a1427178b8dd5e8888f19da0d4)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_add\_part\_rigid\_body\_motion](dynamic__visualization__store__api_8h.xhtml#ab768f6a1427178b8dd5e8888f19da0d4)(

<a id="l00890" name="l00890"></a> 890 int32_t session_id,

<a id="l00891" name="l00891"></a> 891 uint32_t update_num,

<a id="l00892" name="l00892"></a> 892 uint32_t part_id,

<a id="l00893" name="l00893"></a> 893 const float* quaternion,

<a id="l00894" name="l00894"></a> 894 const float* displacement,

<a id="l00895" name="l00895"></a> 895 const float* cg_offset

<a id="l00896" name="l00896"></a> 896);

<a id="l00897" name="l00897"></a> 897 

<a id="l00910" name="l00910"></a>[ 910](dynamic__visualization__store__api_8h.xhtml#a21864240d89612eb1fb81fdceb829d1e)DVS_DLL_EXPORT [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [dvs\_convert\_rotation\_to\_quaternion](dynamic__visualization__store__api_8h.xhtml#a21864240d89612eb1fb81fdceb829d1e)(

<a id="l00911" name="l00911"></a> 911 int32_t session_id,

<a id="l00912" name="l00912"></a> 912 const float* axis_start,

<a id="l00913" name="l00913"></a> 913 const float* axis_end,

<a id="l00914" name="l00914"></a> 914 float relative_rotation_angle,

<a id="l00915" name="l00915"></a> 915 float* quaternion

<a id="l00916" name="l00916"></a> 916);

<a id="l00917" name="l00917"></a> 917 

<a id="l00918" name="l00918"></a> 918\#ifdef \_\_cplusplus

<a id="l00919" name="l00919"></a> 919} /\* End of extern "C" \*/

<a id="l00920" name="l00920"></a> 920\#endif /\* \_\_cplusplus \*/

<a id="l00921" name="l00921"></a> 921\#endif //\_DYNAMIC\_VISUALIZATION\_STORE\_API\_

[dvs\_update\_var\_element\_scalar\_int64](dynamic__visualization__store__api_8h.xhtml#a008017a6bb9e8c8488e392d3cf58f7ad)

DVS_DLL_EXPORT dvs_ret dvs_update_var_element_scalar_int64(int32_t session_id, uint32_t var_id, uint32_t part_id, enum dvs_element_type type, const int64_t *scalars, uint32_t num_vals)

Update a field of int64 scalars on elements.



[dvs\_update\_elements](dynamic__visualization__store__api_8h.xhtml#a05061077e83272567bbc43367c0b8e74)

DVS_DLL_EXPORT dvs_ret dvs_update_elements(int32_t session_id, uint32_t part_id, enum dvs_element_type type, const uint32_t *indices, uint32_t num_indices)

Update elements for a specific part and element type.



[dvs\_server\_create](dynamic__visualization__store__api_8h.xhtml#a06196ff56fe7f270172239c1be4ce0cd)

DVS_DLL_EXPORT dvs_ret dvs_server_create(const char *server_uri, int32_t *server_id)

Create a Dynamic Visualization Store server instance for the client to connect.



[dvs\_update\_var\_part\_vector](dynamic__visualization__store__api_8h.xhtml#a0b8da4c016b09b93b3fcf71afe384b21)

DVS_DLL_EXPORT dvs_ret dvs_update_var_part_vector(int32_t session_id, uint32_t var_id, uint32_t part_id, const float *vec)

Update value of part scalar.



[dvs\_add\_var\_info](dynamic__visualization__store__api_8h.xhtml#a0b9bbed0db0a5f3e91af8a02aed48e1e)

DVS_DLL_EXPORT dvs_ret dvs_add_var_info(int32_t session_id, const struct dvs_var_info *vars, uint32_t num_vars)

Add var info for simulation.



[dvs\_update\_nodes\_parallelepiped](dynamic__visualization__store__api_8h.xhtml#a0d0312c5143eb8de2e08a903c929d8c3)

DVS_DLL_EXPORT dvs_ret dvs_update_nodes_parallelepiped(int32_t session_id, uint32_t part_id, const uint32_t global_ijk_max[3], const uint32_t local_ijk_min[3], const uint32_t local_ijk_max[3], const float origin[3], const float dir_i[3], const float dir_j[3], const float dir_k[3], const float *i_vals, const float *j_vals, const float *k_vals)

Update the nodes for a parallelepiped structured part.



[dvs\_server\_get\_uri](dynamic__visualization__store__api_8h.xhtml#a11887bd000ddab30ababc765e244b094)

DVS_DLL_EXPORT dvs_ret dvs_server_get_uri(int32_t server_id, char *uri, uint32_t *size)

Return the URI of the requested server.



[dvs\_set\_unit\_system](dynamic__visualization__store__api_8h.xhtml#a14b52ceff846429259cab42ee11579f0)

DVS_DLL_EXPORT dvs_ret dvs_set_unit_system(int32_t session_id, const char *system)

Set a unit system (optional but recommended)



[dvs\_convert\_rotation\_to\_quaternion](dynamic__visualization__store__api_8h.xhtml#a21864240d89612eb1fb81fdceb829d1e)

DVS_DLL_EXPORT dvs_ret dvs_convert_rotation_to_quaternion(int32_t session_id, const float *axis_start, const float *axis_end, float relative_rotation_angle, float *quaternion)

Utility API to convert a rigid body rotation described by the rotation axis and the angle of rotation...



[dvs\_print\_stats](dynamic__visualization__store__api_8h.xhtml#a345e9b656b994a3e1677b354077b2fff)

DVS_DLL_EXPORT dvs_ret dvs_print_stats(int32_t session_id)

This will be deprecated, just placeholder for printing out stats that the client is collecting for pr...



[dvs\_get\_var\_id](dynamic__visualization__store__api_8h.xhtml#a355c95f11b171a15755f748da3349e67)

DVS_DLL_EXPORT dvs_ret dvs_get_var_id(int32_t session_id, const char *name, uint32_t *id)

Get the ID being used by the client for the named var.



[dvs\_begin\_init](dynamic__visualization__store__api_8h.xhtml#a3744408f15cd4a36d19880d24d442a0d)

DVS_DLL_EXPORT dvs_ret dvs_begin_init(int32_t session_id, const char *dataset_name, uint32_t current_rank, uint32_t total_ranks, uint32_t num_chunks)

begin setup of rank



[dvs\_get\_plot\_id](dynamic__visualization__store__api_8h.xhtml#a3ae625f138573f6fa9904f0609ca1eb1)

DVS_DLL_EXPORT dvs_ret dvs_get_plot_id(int32_t session_id, const char *name, uint32_t *id)

Get the ID being used by the client for the named plot.



[dvs\_update\_plot](dynamic__visualization__store__api_8h.xhtml#a433ce5100e551dca71dee92b0afe1563)

DVS_DLL_EXPORT dvs_ret dvs_update_plot(int32_t session_id, uint32_t plot_id, const float *x_values, const float *y_values, uint32_t num_values)

Update the data for a plot.



[dvs\_add\_part\_info](dynamic__visualization__store__api_8h.xhtml#a4e8a904ae19fd7f2b0c300543bc42576)

DVS_DLL_EXPORT dvs_ret dvs_add_part_info(int32_t session_id, const struct dvs_part_info *parts, uint32_t num_parts)

Add part info for simulation.



[dvs\_delete\_item](dynamic__visualization__store__api_8h.xhtml#a5237ada583b0cb7817d12d1135f9349e)

DVS_DLL_EXPORT dvs_ret dvs_delete_item(int32_t session_id, uint32_t update_num, uint32_t rank, const char *filter)

Delete an item.



[dvs\_get\_num\_part\_info](dynamic__visualization__store__api_8h.xhtml#a5a6cd68f61a53bce6780d3ef95038277)

DVS_DLL_EXPORT uint32_t dvs_get_num_part_info(int32_t session_id)

Get the number of dvs_part_info objects for this client session.



[dvs\_get\_part\_info](dynamic__visualization__store__api_8h.xhtml#a5b5a64e37bd6830f518947e7a0f7985e)

DVS_DLL_EXPORT const struct dvs_part_info * dvs_get_part_info(int32_t session_id, uint32_t index)

Get the dvs_part_info object for this index.



[dvs\_update\_elements\_polygon](dynamic__visualization__store__api_8h.xhtml#a763afb059b0301ba18fefe3cd126ce79)

DVS_DLL_EXPORT dvs_ret dvs_update_elements_polygon(int32_t session_id, uint32_t part_id, enum dvs_element_type type, const uint32_t *nodes_per_polygon, uint32_t nodes_per_polygon_size, const uint32_t *indices, uint32_t indices_size)

Update N-SIDED elements.



[dvs\_update\_var\_node\_scalar\_int64](dynamic__visualization__store__api_8h.xhtml#a7c130a702347b1baa7e884303f3ce9d5)

DVS_DLL_EXPORT dvs_ret dvs_update_var_node_scalar_int64(int32_t session_id, uint32_t var_id, uint32_t part_id, const int64_t *scalars, uint32_t num_vals)

Update a field of int64 scalars on nodes.



[dvs\_update\_nodes](dynamic__visualization__store__api_8h.xhtml#a7fdc956a0712ef2a60195fa013e59222)

DVS_DLL_EXPORT dvs_ret dvs_update_nodes(int32_t session_id, uint32_t part_id, const float *x, const float *y, const float *z, uint32_t num_values)

Update nodes for a specific part.



[dvs\_log\_func](dynamic__visualization__store__api_8h.xhtml#a80c7c60e9cd61fcc0a0aacac09d66947)

void(* dvs_log_func)(void *, const char *)

Function pointer for logging methods.

**Definition:** [dynamic\_visualization\_store\_api.h:143](dynamic__visualization__store__api_8h_source.xhtml#l00143)



[dvs\_shutdown](dynamic__visualization__store__api_8h.xhtml#a815bb1d2251e35e3bfd3c44a4a338052)

DVS_DLL_EXPORT void dvs_shutdown()

Shuts down the api, performing any necessary cleanup, also calls dvs_server_shutdown_all() if any ser...



[dvs\_update\_var\_part\_scalar](dynamic__visualization__store__api_8h.xhtml#a853ed7ef2608619b82dd51055cee3f60)

DVS_DLL_EXPORT dvs_ret dvs_update_var_part_scalar(int32_t session_id, uint32_t var_id, uint32_t part_id, float scalar)

Update value of part scalar.



[dvs\_get\_var\_info](dynamic__visualization__store__api_8h.xhtml#a8992f4a5e6c36c5e4da67968b170313c)

DVS_DLL_EXPORT const struct dvs_var_info * dvs_get_var_info(int32_t session_id, uint32_t index)

Get the dvs_var_info object for this index.



[dvs\_update\_var\_node\_vector](dynamic__visualization__store__api_8h.xhtml#a9086155711ed76c6141bdde2291f140a)

DVS_DLL_EXPORT dvs_ret dvs_update_var_node_vector(int32_t session_id, uint32_t var_id, uint32_t part_id, const float *values, uint32_t num_values)

Update a field of vectors on nodes.



[dvs\_server\_started](dynamic__visualization__store__api_8h.xhtml#a996a1d0e1696ad7f991e44357d78a422)

DVS_DLL_EXPORT dvs_ret dvs_server_started(int32_t server_id, uint32_t *running)

Check to see if a server was started with this server_num.



[dvs\_get\_num\_plot\_info](dynamic__visualization__store__api_8h.xhtml#aa44dcb6596c7833d2b9fe2a0435bb4c4)

DVS_DLL_EXPORT uint32_t dvs_get_num_plot_info(int32_t session_id)

Get the number of dvs_plot_info objects for this client session.



[dvs\_server\_start](dynamic__visualization__store__api_8h.xhtml#aa5722a5316ee73bdd998c9a327e8cb3d)

DVS_DLL_EXPORT dvs_ret dvs_server_start(int32_t server_id, uint32_t server_number, uint32_t local_ranks)

Start a Dynamic Visualization Store server in a separate thread to receive data from solver node.



[dvs\_begin\_update](dynamic__visualization__store__api_8h.xhtml#aaac598618be531e8aa2b72ad41e18537)

DVS_DLL_EXPORT dvs_ret dvs_begin_update(int32_t session_id, uint32_t update_num, uint32_t rank, uint32_t chunk, float time)

Method to begin an update.



[dvs\_update\_var\_element\_scalar](dynamic__visualization__store__api_8h.xhtml#aae3c0a5237c193d05266fba6e6798a4c)

DVS_DLL_EXPORT dvs_ret dvs_update_var_element_scalar(int32_t session_id, uint32_t var_id, uint32_t part_id, enum dvs_element_type type, const float *scalars, uint32_t num_vals)

Update a field of scalars on elements.



[dvs\_update\_var\_case\_vector](dynamic__visualization__store__api_8h.xhtml#ab4e0ac12018e08551d6b8121971fea7e)

DVS_DLL_EXPORT dvs_ret dvs_update_var_case_vector(int32_t session_id, uint32_t var_id, const float *vec)

Update value of case vector.



[dvs\_add\_part\_rigid\_body\_motion](dynamic__visualization__store__api_8h.xhtml#ab768f6a1427178b8dd5e8888f19da0d4)

DVS_DLL_EXPORT dvs_ret dvs_add_part_rigid_body_motion(int32_t session_id, uint32_t update_num, uint32_t part_id, const float *quaternion, const float *displacement, const float *cg_offset)

Add rigid body motion data to a specific part for a specific update. Any non-needed input can be set ...



[dvs\_get\_version](dynamic__visualization__store__api_8h.xhtml#ab8e85aad9b7ec78976db76017803a6b6)

DVS_DLL_EXPORT const char * dvs_get_version()

Get the current version of the built library.



[dvs\_connect](dynamic__visualization__store__api_8h.xhtml#ab96812d4412a9af10e7e7924c572a7c9)

DVS_DLL_EXPORT dvs_ret dvs_connect(int32_t server_id, enum dvs_client_flags flags, const char *secret, int32_t *session_id)

Connect to dvs server.



[dvs\_session\_shutdown](dynamic__visualization__store__api_8h.xhtml#abf84206bdff4c0d6f00ada37f6eadf55)

DVS_DLL_EXPORT dvs_ret dvs_session_shutdown(int32_t session_id)

Shutdown session.



[dvs\_server\_shutdown\_all](dynamic__visualization__store__api_8h.xhtml#ac16a3c06bb1968ddba06d83f5e2a1f56)

DVS_DLL_EXPORT void dvs_server_shutdown_all()

Shutdown all server threads.



[dvs\_get\_plot\_info](dynamic__visualization__store__api_8h.xhtml#ac3fca7087e8b4366686cef98a95f241f)

DVS_DLL_EXPORT const struct dvs_plot_info * dvs_get_plot_info(int32_t session_id, uint32_t index)

Get the dvs_plot_info object for this index.



[dvs\_end\_init](dynamic__visualization__store__api_8h.xhtml#ac4d82529053c964b76bd42916c51835e)

DVS_DLL_EXPORT dvs_ret dvs_end_init(int32_t session_id)

end the initialization of the rank



[dvs\_add\_metadata](dynamic__visualization__store__api_8h.xhtml#ac5c67fdc3806bf89eebbe49e6daea5c2)

DVS_DLL_EXPORT dvs_ret dvs_add_metadata(int32_t session_id, const char *const metadata_keys[], const char *const metadata_vals[], uint32_t num_metadata_pairs)

Add metadata for the current dataset.



[dvs\_server\_shutdown](dynamic__visualization__store__api_8h.xhtml#ad16ba277108c7187b0a11f461b1477ca)

DVS_DLL_EXPORT dvs_ret dvs_server_shutdown(int32_t server_id)

Shutdown this server thread.



[dvs\_get\_num\_var\_info](dynamic__visualization__store__api_8h.xhtml#ad75625cedecbcd365c868c9893c6c2d8)

DVS_DLL_EXPORT uint32_t dvs_get_num_var_info(int32_t session_id)

Get the number of dvs_var_info objects for this client session.



[dvs\_update\_var\_case\_scalar](dynamic__visualization__store__api_8h.xhtml#ad97de401448e85da8cb13d3e45cfb227)

DVS_DLL_EXPORT dvs_ret dvs_update_var_case_scalar(int32_t session_id, uint32_t var_id, float scalar)

Update value of case scalar.



[dvs\_session\_shutdown\_all](dynamic__visualization__store__api_8h.xhtml#adc2aa26177a1b4a487b3c8f3f7b7b23d)

DVS_DLL_EXPORT void dvs_session_shutdown_all()

Shutdown all connected sessions.



[dvs\_server\_timestep\_count](dynamic__visualization__store__api_8h.xhtml#adeb64f5db63b08a79f2a59a85c5d9683)

DVS_DLL_EXPORT dvs_ret dvs_server_timestep_count(int32_t server_id, uint32_t *num_pending, uint32_t *num_complete)

Query a Dynamic Visualization Store server as to the number of timesteps it contains.



[dvs\_register\_log\_func](dynamic__visualization__store__api_8h.xhtml#ae57cf8cf0b10421aace6df32a98c60ae)

DVS_DLL_EXPORT dvs_ret dvs_register_log_func(int32_t session_id, void *user_data, dvs_log_func func, enum dvs_log_flags flags)

Register logging function for client to call (optional but recommended)



[dvs\_end\_update](dynamic__visualization__store__api_8h.xhtml#ae75177bf47fcb28313e79840bf778c75)

DVS_DLL_EXPORT dvs_ret dvs_end_update(int32_t session_id)

Call to end the update for this timestep/rank/chunk.



[dvs\_server\_set\_option](dynamic__visualization__store__api_8h.xhtml#ae8abdb8455cea44bbd9f509c1a063516)

DVS_DLL_EXPORT dvs_ret dvs_server_set_option(int32_t server_id, const char *key, const char *value)

Add an option to the server.



[dvs\_update\_var\_node\_scalar](dynamic__visualization__store__api_8h.xhtml#aea17a7bbdc6ac8c2cdd4e6c35c1a8578)

DVS_DLL_EXPORT dvs_ret dvs_update_var_node_scalar(int32_t session_id, uint32_t var_id, uint32_t part_id, const float *scalars, uint32_t num_vals)

Update a field of scalars on nodes.



[dvs\_get\_part\_id](dynamic__visualization__store__api_8h.xhtml#aefeb5e79919700a670799d9f3e8f0e2c)

DVS_DLL_EXPORT dvs_ret dvs_get_part_id(int32_t session_id, const char *name, uint32_t *id)

Get the ID being used by the client for the named part.



[dvs\_update\_copy\_previous\_part](dynamic__visualization__store__api_8h.xhtml#af2223790199210c6fd1f5ac5ade6c60a)

DVS_DLL_EXPORT dvs_ret dvs_update_copy_previous_part(int32_t session_id, uint32_t part_id, const char *options)

Copy data from the previous timestep before applying other data.



[dvs\_update\_var\_element\_vector](dynamic__visualization__store__api_8h.xhtml#af3cd5ecfd626ca40b1273634734f38d5)

DVS_DLL_EXPORT dvs_ret dvs_update_var_element_vector(int32_t session_id, uint32_t var_id, uint32_t part_id, enum dvs_element_type type, const float *values, uint32_t num_values)

Update a field of vectors on elements.



[dvs\_update\_nodes\_curvilinear](dynamic__visualization__store__api_8h.xhtml#af69daaa5a2ac63f7ce31a2e8e3d66332)

DVS_DLL_EXPORT dvs_ret dvs_update_nodes_curvilinear(int32_t session_id, uint32_t part_id, const uint32_t global_ijk_max[3], const uint32_t local_ijk_min[3], const uint32_t local_ijk_max[3], const float *x_vals, const float *y_vals, const float *z_vals)

Update the nodes for a curvilinear structured part.



[dvs\_add\_plot\_info](dynamic__visualization__store__api_8h.xhtml#afe298f932fd909b7caabd6f430489b16)

DVS_DLL_EXPORT dvs_ret dvs_add_plot_info(int32_t session_id, const struct dvs_plot_info *plots, uint32_t num_plots)

Add plot info for simulation.



[dvs\_update\_elements\_polyhedral](dynamic__visualization__store__api_8h.xhtml#aff070e9087ba34f41200ff0cd1d3002e)

DVS_DLL_EXPORT dvs_ret dvs_update_elements_polyhedral(int32_t session_id, uint32_t part_id, enum dvs_element_type type, const uint32_t *faces_per_element, uint32_t faces_per_element_size, const uint32_t *nodes_per_face, uint32_t nodes_per_face_size, const uint32_t *indices, uint32_t indices_size)

Update N-FACED Elements.



[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)

Contains enums used in C/C++ API.



[dvs\_log\_flags](dynamic__visualization__store__enums_8h.xhtml#a9bca12092877a90e6c497994093a8609)

dvs_log_flags

Flags to control logging filters.

**Definition:** [dynamic\_visualization\_store\_enums.h:67](dynamic__visualization__store__enums_8h_source.xhtml#l00066)



[dvs\_client\_flags](dynamic__visualization__store__enums_8h.xhtml#aec8cbac60b9cafe5d1c0ad6593f05e9f)

dvs_client_flags

Flags for specific server setup.

**Definition:** [dynamic\_visualization\_store\_enums.h:55](dynamic__visualization__store__enums_8h_source.xhtml#l00054)



[dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895)

dvs_element_type

List of macro generated enums.

**Definition:** [dynamic\_visualization\_store\_enums.h:198](dynamic__visualization__store__enums_8h_source.xhtml#l00198)



[dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491)

dvs_var_location

What variable is associated with.

**Definition:** [dynamic\_visualization\_store\_enums.h:18](dynamic__visualization__store__enums_8h_source.xhtml#l00017)



[dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0)

dvs_var_type

Data type of variable.

**Definition:** [dynamic\_visualization\_store\_enums.h:30](dynamic__visualization__store__enums_8h_source.xhtml#l00029)



[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)



[dynamic\_visualization\_store\_version.h](dynamic__visualization__store__version_8h.xhtml)

C API for using Dynamic Visualization Store.



[dvs\_part\_info](structdvs__part__info.xhtml)

Struct holding information for a part's definition.

**Definition:** [dynamic\_visualization\_store\_api.h:77](dynamic__visualization__store__api_8h_source.xhtml#l00076)



[dvs\_part\_info::\_metadata\_vals](structdvs__part__info.xhtml#a59c04a77c663b68008a1f69b62574337)

char ** _metadata_vals

UTF-8 Compatible value, each array should be null terminate.

**Definition:** [dynamic\_visualization\_store\_api.h:84](dynamic__visualization__store__api_8h_source.xhtml#l00084)



[dvs\_part\_info::\_name](structdvs__part__info.xhtml#aa3ef86ed8620b0419f05e4e255dd01fb)

char * _name

UTF-8 Compatible name of part [null terminated], max name length visible in GUI == 79,...

**Definition:** [dynamic\_visualization\_store\_api.h:79](dynamic__visualization__store__api_8h_source.xhtml#l00079)



[dvs\_part\_info::\_structured](structdvs__part__info.xhtml#ab458569530b84c8a2403b2610af98989)

uint8_t _structured

Structured flag. 0 if unstructured, 1 if structured.

**Definition:** [dynamic\_visualization\_store\_api.h:80](dynamic__visualization__store__api_8h_source.xhtml#l00080)



[dvs\_part\_info::\_id](structdvs__part__info.xhtml#ab4e6fd830f27fdfa60c7bf6c2c137695)

uint32_t _id

Unique identifier for part, MUST BE &gt; 0.

**Definition:** [dynamic\_visualization\_store\_api.h:78](dynamic__visualization__store__api_8h_source.xhtml#l00078)



[dvs\_part\_info::\_metadata\_num\_pairs](structdvs__part__info.xhtml#adb36557a49efa5373a258141dd472385)

uint32_t _metadata_num_pairs

Number of arrays in _metadata_keys/_metadata_vals.

**Definition:** [dynamic\_visualization\_store\_api.h:82](dynamic__visualization__store__api_8h_source.xhtml#l00082)



[dvs\_part\_info::\_metadata\_keys](structdvs__part__info.xhtml#aef3ab830a0bfcab49d9cbed978e315c2)

char ** _metadata_keys

UTF-8 Compatible key , each array should be null terminated.

**Definition:** [dynamic\_visualization\_store\_api.h:83](dynamic__visualization__store__api_8h_source.xhtml#l00083)



[dvs\_part\_info::\_chunking](structdvs__part__info.xhtml#af688078624a42e9ab53d3c194e2861c3)

uint8_t _chunking

1 if using chunks

**Definition:** [dynamic\_visualization\_store\_api.h:81](dynamic__visualization__store__api_8h_source.xhtml#l00081)



[dvs\_plot\_info](structdvs__plot__info.xhtml)

Struct holding information for a plot's definition.

**Definition:** [dynamic\_visualization\_store\_api.h:109](dynamic__visualization__store__api_8h_source.xhtml#l00108)



[dvs\_plot\_info::\_name](structdvs__plot__info.xhtml#a00c93696be3b5f9f3c2288daf9975f19)

char * _name

UTF-8 Compatible name for plot, must be unique from other plot names.

**Definition:** [dynamic\_visualization\_store\_api.h:111](dynamic__visualization__store__api_8h_source.xhtml#l00111)



[dvs\_plot\_info::\_metadata\_num\_pairs](structdvs__plot__info.xhtml#a2d0bc2ca11580a27d9a8637a848d6e14)

uint32_t _metadata_num_pairs

Number of arrays in _metadata_keys/_metadata_vals.

**Definition:** [dynamic\_visualization\_store\_api.h:116](dynamic__visualization__store__api_8h_source.xhtml#l00116)



[dvs\_plot\_info::\_y\_axis\_units](structdvs__plot__info.xhtml#a368da9b3c7dd1b8b8b37daed5d97554d)

char * _y_axis_units

///&lt; UTF-8 Compatible unit type, see: https://nexusdemo.ensight.com/docs/python/html/ENS_UNITSSchema....

**Definition:** [dynamic\_visualization\_store\_api.h:115](dynamic__visualization__store__api_8h_source.xhtml#l00115)



[dvs\_plot\_info::\_metadata\_vals](structdvs__plot__info.xhtml#a467b2e79ceb431c9358423647de59699)

char ** _metadata_vals

UTF-8 Compatible value, each array should be null terminated.

**Definition:** [dynamic\_visualization\_store\_api.h:118](dynamic__visualization__store__api_8h_source.xhtml#l00118)



[dvs\_plot\_info::\_metadata\_keys](structdvs__plot__info.xhtml#a6182c10a62849ada795123fd6707d612)

char ** _metadata_keys

UTF-8 Compatible key , each array should be null terminated.

**Definition:** [dynamic\_visualization\_store\_api.h:117](dynamic__visualization__store__api_8h_source.xhtml#l00117)



[dvs\_plot\_info::\_x\_axis\_title](structdvs__plot__info.xhtml#a6cdeb2ede603f7aa96c515e2691e11a0)

char * _x_axis_title

UTF-8 Compatible x axis title.

**Definition:** [dynamic\_visualization\_store\_api.h:112](dynamic__visualization__store__api_8h_source.xhtml#l00112)



[dvs\_plot\_info::\_id](structdvs__plot__info.xhtml#a7721b22bb882c90e84d68979a748daf3)

uint32_t _id

Unique id for plot.

**Definition:** [dynamic\_visualization\_store\_api.h:110](dynamic__visualization__store__api_8h_source.xhtml#l00110)



[dvs\_plot\_info::\_x\_axis\_units](structdvs__plot__info.xhtml#aac4a7335b4bcda68808eea67e280346b)

char * _x_axis_units

///&lt; UTF-8 Compatible unit type, see: https://nexusdemo.ensight.com/docs/python/html/ENS_UNITSSchema....

**Definition:** [dynamic\_visualization\_store\_api.h:113](dynamic__visualization__store__api_8h_source.xhtml#l00113)



[dvs\_plot\_info::\_y\_axis\_title](structdvs__plot__info.xhtml#aae1ce6d97a55e3da272f552508f61e11)

char * _y_axis_title

UTF-8 Compatible y axis title.

**Definition:** [dynamic\_visualization\_store\_api.h:114](dynamic__visualization__store__api_8h_source.xhtml#l00114)



[dvs\_var\_info](structdvs__var__info.xhtml)

Struct holding information for a variable's definiton.

**Definition:** [dynamic\_visualization\_store\_api.h:92](dynamic__visualization__store__api_8h_source.xhtml#l00091)



[dvs\_var\_info::\_unit\_label](structdvs__var__info.xhtml#a262ba1165d1929418e03a2a250774525)

char * _unit_label

UTF-8 Compatible label, see: https://nexusdemo.ensight.com/docs/python/html/ENS_UNITSSchema....

**Definition:** [dynamic\_visualization\_store\_api.h:98](dynamic__visualization__store__api_8h_source.xhtml#l00098)



[dvs\_var\_info::\_unit](structdvs__var__info.xhtml#a3d7cdb8a063eaf6c94f95f3b589c8624)

char * _unit

UTF-8 Compatible unit type, see: https://nexusdemo.ensight.com/docs/python/html/ENS_UNITSSchema....

**Definition:** [dynamic\_visualization\_store\_api.h:97](dynamic__visualization__store__api_8h_source.xhtml#l00097)



[dvs\_var\_info::\_type](structdvs__var__info.xhtml#a721f90cd12b7e98cf0d2fcf99ed9c7a9)

enum dvs_var_type _type

Type of variable, see dvs_var_type enum (dynamic_visualization_store_enums.h)

**Definition:** [dynamic\_visualization\_store\_api.h:95](dynamic__visualization__store__api_8h_source.xhtml#l00095)



[dvs\_var\_info::\_metadata\_keys](structdvs__var__info.xhtml#a9c656726edeeb5c0cf5b9a42f870b3a2)

char ** _metadata_keys

UTF-8 Compatible key , each array should be null terminated.

**Definition:** [dynamic\_visualization\_store\_api.h:100](dynamic__visualization__store__api_8h_source.xhtml#l00100)



[dvs\_var\_info::\_metadata\_num\_pairs](structdvs__var__info.xhtml#a9f99fd8ad9d004f44939c830747ebfc8)

uint32_t _metadata_num_pairs

Number of arrays in _metadata_keys/_metadata_vals.

**Definition:** [dynamic\_visualization\_store\_api.h:99](dynamic__visualization__store__api_8h_source.xhtml#l00099)



[dvs\_var\_info::\_id](structdvs__var__info.xhtml#abcef03f7b1e419ae39c7511de2385a9b)

uint32_t _id

Unique id for variable.

**Definition:** [dynamic\_visualization\_store\_api.h:93](dynamic__visualization__store__api_8h_source.xhtml#l00093)



[dvs\_var\_info::\_metadata\_vals](structdvs__var__info.xhtml#abe0afbff61a368336c7750c831a3c056)

char ** _metadata_vals

UTF-8 Compatible value, each array should be null terminated.

**Definition:** [dynamic\_visualization\_store\_api.h:101](dynamic__visualization__store__api_8h_source.xhtml#l00101)



[dvs\_var\_info::\_location](structdvs__var__info.xhtml#abfd6a4461939e798ebdc5d6714a4558f)

enum dvs_var_location _location

Location of variable (case/part/element/node), see dvs_var_location enum (dynamic_visualization_store...

**Definition:** [dynamic\_visualization\_store\_api.h:96](dynamic__visualization__store__api_8h_source.xhtml#l00096)



[dvs\_var\_info::\_name](structdvs__var__info.xhtml#ad1b4aeadeb75d6ab2a446fef37f11d0a)

char * _name

UTF-8 Compatible name of variable [null terminated], max name length visible in the GUI == 49,...

**Definition:** [dynamic\_visualization\_store\_api.h:94](dynamic__visualization__store__api_8h_source.xhtml#l00094)