## On this page

  

 

 # dvs\_client\_interface

 Last update: 16.07.2025 

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

<a id="l00002" name="l00002"></a> 2  \* Copyright 2017-2018 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 \_\_\_DVS\_DYNAMIC\_VISUALIZATION\_STORE\_CLIENT\_INTERFACE\_\_\_

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

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

<a id="l00062" name="l00062"></a> 62 \#include &lt;string&gt;

<a id="l00063" name="l00063"></a> 63 

<a id="l00064" name="l00064"></a> 64 \#include "[dvs\_server\_interface.h](dvs__server__interface_8h.xhtml)"

<a id="l00065" name="l00065"></a> 65 \#include "[dynamic\_visualization\_store\_api.h](dynamic__visualization__store__api_8h.xhtml)"

<a id="l00066" name="l00066"></a> 66 \#include "[logger\_interface.h](logger__interface_8h.xhtml)"

<a id="l00067" name="l00067"></a> 67 

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

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

<a id="l00070" name="l00070"></a> 70 namespace DVS

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

<a id="l00080" name="l00080"></a>[ 80](class_d_v_s_1_1_i_client.xhtml) class [IClient](class_d_v_s_1_1_i_client.xhtml)

<a id="l00081" name="l00081"></a> 81 {

<a id="l00082" name="l00082"></a> 82 public:

<a id="l00083" name="l00083"></a> 83 

<a id="l00084" name="l00084"></a> 84 

<a id="l00085" name="l00085"></a>[ 85](class_d_v_s_1_1_i_client.xhtml#a64eedec7e83a7e05ae9b3ca96c9f79b6) [IClient](class_d_v_s_1_1_i_client.xhtml#a64eedec7e83a7e05ae9b3ca96c9f79b6)() = default; 

<a id="l00086" name="l00086"></a>[ 86](class_d_v_s_1_1_i_client.xhtml#ab54b2523137180da43fa39b2e597eb0d) virtual [~IClient](class_d_v_s_1_1_i_client.xhtml#ab54b2523137180da43fa39b2e597eb0d)() = default; 

<a id="l00087" name="l00087"></a>[ 87](class_d_v_s_1_1_i_client.xhtml#a3833003a214593bcf229917fe9f677d0) [IClient](class_d_v_s_1_1_i_client.xhtml#a3833003a214593bcf229917fe9f677d0)([IClient](class_d_v_s_1_1_i_client.xhtml)&amp;&amp;) = default; 

<a id="l00088" name="l00088"></a>[ 88](class_d_v_s_1_1_i_client.xhtml#a06c322b0c109e9fe8de05b8991d638e0) [IClient](class_d_v_s_1_1_i_client.xhtml)&amp; [operator=](class_d_v_s_1_1_i_client.xhtml#a06c322b0c109e9fe8de05b8991d638e0)([IClient](class_d_v_s_1_1_i_client.xhtml)&amp;&amp;) = default; 

<a id="l00089" name="l00089"></a>[ 89](class_d_v_s_1_1_i_client.xhtml#a7cf4e8dfda9a6d9de1ab8ca4ea64961f) [IClient](class_d_v_s_1_1_i_client.xhtml#a7cf4e8dfda9a6d9de1ab8ca4ea64961f)(const [IClient](class_d_v_s_1_1_i_client.xhtml)&amp;) = default; 

<a id="l00090" name="l00090"></a>[ 90](class_d_v_s_1_1_i_client.xhtml#a738cf29fb146b4c56e81e25954855b92) [IClient](class_d_v_s_1_1_i_client.xhtml)&amp; [operator=](class_d_v_s_1_1_i_client.xhtml#a738cf29fb146b4c56e81e25954855b92)(const [IClient](class_d_v_s_1_1_i_client.xhtml)&amp;) = default; 

<a id="l00091" name="l00091"></a> 91 

<a id="l00102" name="l00102"></a>[ 102](class_d_v_s_1_1_i_client.xhtml#a024475b03496bc310e211632d153517d) virtual void [set\_logger](class_d_v_s_1_1_i_client.xhtml#a024475b03496bc310e211632d153517d)([ILogger](class_d_v_s_1_1_i_logger.xhtml)* logger) = 0;

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

<a id="l00114" name="l00114"></a>[ 114](class_d_v_s_1_1_i_client.xhtml#ac65e50e425b440f4b84dd1decc3478c9) virtual const char* [get\_version](class_d_v_s_1_1_i_client.xhtml#ac65e50e425b440f4b84dd1decc3478c9)() = 0;

<a id="l00115" name="l00115"></a> 115 

<a id="l00125" name="l00125"></a>[ 125](class_d_v_s_1_1_i_client.xhtml#aff782ecd341fddd87a22a15107efeb3b) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [begin\_init](class_d_v_s_1_1_i_client.xhtml#aff782ecd341fddd87a22a15107efeb3b)(const char* dataset_name, uint32_t current_rank, uint32_t total_ranks, uint32_t num_chunks) = 0;

<a id="l00126" name="l00126"></a> 126 

<a id="l00135" name="l00135"></a>[ 135](class_d_v_s_1_1_i_client.xhtml#a284f922fec402e03365c7873502d1fde) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [set\_unit\_system](class_d_v_s_1_1_i_client.xhtml#a284f922fec402e03365c7873502d1fde)(const char* system) = 0;

<a id="l00136" name="l00136"></a> 136 

<a id="l00154" name="l00154"></a>[ 154](class_d_v_s_1_1_i_client.xhtml#ab4144e59bfdcf9c095c6510c4298d160) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [add\_metadata](class_d_v_s_1_1_i_client.xhtml#ab4144e59bfdcf9c095c6510c4298d160)(const char* const keys[], const char* const vals[], uint32_t num_metadata_pairs) = 0;

<a id="l00155" name="l00155"></a> 155 

<a id="l00165" name="l00165"></a>[ 165](class_d_v_s_1_1_i_client.xhtml#a5e9ee6af237e76a6e270d99ec8cd4388) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [add\_part\_info](class_d_v_s_1_1_i_client.xhtml#a5e9ee6af237e76a6e270d99ec8cd4388)(const [dvs\_part\_info](structdvs__part__info.xhtml)* part_info, uint32_t num_parts) = 0;

<a id="l00166" name="l00166"></a> 166 

<a id="l00176" name="l00176"></a>[ 176](class_d_v_s_1_1_i_client.xhtml#a82f841d7f6f33071bf8c709623ca215d) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [add\_var\_info](class_d_v_s_1_1_i_client.xhtml#a82f841d7f6f33071bf8c709623ca215d)(const [dvs\_var\_info](structdvs__var__info.xhtml)* var_info, uint32_t num_vars) = 0;

<a id="l00177" name="l00177"></a> 177 

<a id="l00187" name="l00187"></a>[ 187](class_d_v_s_1_1_i_client.xhtml#a1bdb7ca9cf25c63e533f47fe26132af6) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [add\_plot\_info](class_d_v_s_1_1_i_client.xhtml#a1bdb7ca9cf25c63e533f47fe26132af6)(const [dvs\_plot\_info](structdvs__plot__info.xhtml)* plot_info, uint32_t num_plots) = 0;

<a id="l00188" name="l00188"></a> 188 

<a id="l00197" name="l00197"></a>[ 197](class_d_v_s_1_1_i_client.xhtml#af609f80df51a124a137c6476b7d3c958) virtual uint32_t [get\_num\_parts](class_d_v_s_1_1_i_client.xhtml#af609f80df51a124a137c6476b7d3c958)() const = 0;

<a id="l00198" name="l00198"></a> 198 

<a id="l00207" name="l00207"></a>[ 207](class_d_v_s_1_1_i_client.xhtml#a85adbf75ade9d0ffc6d258c34dae1eb3) virtual uint32_t [get\_num\_vars](class_d_v_s_1_1_i_client.xhtml#a85adbf75ade9d0ffc6d258c34dae1eb3)() const = 0;

<a id="l00208" name="l00208"></a> 208 

<a id="l00217" name="l00217"></a>[ 217](class_d_v_s_1_1_i_client.xhtml#a80325aaa83f2d2f27f1aa8e5f167c4c6) virtual uint32_t [get\_num\_plots](class_d_v_s_1_1_i_client.xhtml#a80325aaa83f2d2f27f1aa8e5f167c4c6)() const = 0;

<a id="l00218" name="l00218"></a> 218 

<a id="l00228" name="l00228"></a>[ 228](class_d_v_s_1_1_i_client.xhtml#af96a3f9cef0204d8c04032e9ce3e3f59) virtual const [dvs\_part\_info](structdvs__part__info.xhtml)* [get\_part\_info](class_d_v_s_1_1_i_client.xhtml#af96a3f9cef0204d8c04032e9ce3e3f59)(uint32_t index) const = 0;

<a id="l00229" name="l00229"></a> 229 

<a id="l00244" name="l00244"></a>[ 244](class_d_v_s_1_1_i_client.xhtml#a4e3e6fbf66582927a17b54c9fba3464c) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_part\_id](class_d_v_s_1_1_i_client.xhtml#a4e3e6fbf66582927a17b54c9fba3464c)(const std::string&amp; name, uint32_t&amp; id) const = 0;

<a id="l00245" name="l00245"></a> 245 

<a id="l00255" name="l00255"></a>[ 255](class_d_v_s_1_1_i_client.xhtml#a2749739390de2501b4ae4de0ad878703) virtual const [dvs\_var\_info](structdvs__var__info.xhtml)* [get\_var\_info](class_d_v_s_1_1_i_client.xhtml#a2749739390de2501b4ae4de0ad878703)(uint32_t index) const = 0;

<a id="l00256" name="l00256"></a> 256 

<a id="l00271" name="l00271"></a>[ 271](class_d_v_s_1_1_i_client.xhtml#ac4a86f03c9eb353cb1d92e326945cb9c) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_var\_id](class_d_v_s_1_1_i_client.xhtml#ac4a86f03c9eb353cb1d92e326945cb9c)(const std::string&amp; name, uint32_t&amp; id) const = 0;

<a id="l00272" name="l00272"></a> 272 

<a id="l00282" name="l00282"></a>[ 282](class_d_v_s_1_1_i_client.xhtml#ac9690e1df7282cfde97d8a27a1438bb2) virtual const [dvs\_plot\_info](structdvs__plot__info.xhtml)* [get\_plot\_info](class_d_v_s_1_1_i_client.xhtml#ac9690e1df7282cfde97d8a27a1438bb2)(uint32_t index) const = 0;

<a id="l00283" name="l00283"></a> 283 

<a id="l00298" name="l00298"></a>[ 298](class_d_v_s_1_1_i_client.xhtml#a5dc7f1a7c19c068b04a384c1891e435f) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_plot\_id](class_d_v_s_1_1_i_client.xhtml#a5dc7f1a7c19c068b04a384c1891e435f)(const std::string&amp; name, uint32_t&amp; id) const = 0;

<a id="l00299" name="l00299"></a> 299 

<a id="l00307" name="l00307"></a>[ 307](class_d_v_s_1_1_i_client.xhtml#aaf1641a1afbf8bb6257940be28dd94b2) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [end\_init](class_d_v_s_1_1_i_client.xhtml#aaf1641a1afbf8bb6257940be28dd94b2)() = 0;

<a id="l00308" name="l00308"></a> 308 

<a id="l00318" name="l00318"></a>[ 318](class_d_v_s_1_1_i_client.xhtml#abd1cbbd2007346ad616dc74eab9d0553) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [begin\_update](class_d_v_s_1_1_i_client.xhtml#abd1cbbd2007346ad616dc74eab9d0553)(uint32_t update_num, uint32_t rank, uint32_t chunk, float time) = 0;

<a id="l00319" name="l00319"></a> 319 

<a id="l00330" name="l00330"></a>[ 330](class_d_v_s_1_1_i_client.xhtml#a87ab36c2f16d093c0beaba60da2cd661) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_nodes](class_d_v_s_1_1_i_client.xhtml#a87ab36c2f16d093c0beaba60da2cd661)(uint32_t part_id, const float* x, const float* y, const float* z, uint32_t num_values) = 0;

<a id="l00331" name="l00331"></a> 331 

<a id="l00372" name="l00372"></a>[ 372](class_d_v_s_1_1_i_client.xhtml#a1588c437020e0ba5702ec48460a792a9) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_nodes\_structured](class_d_v_s_1_1_i_client.xhtml#a1588c437020e0ba5702ec48460a792a9)

<a id="l00373" name="l00373"></a> 373 (

<a id="l00374" name="l00374"></a> 374 uint32_t part_id,

<a id="l00375" name="l00375"></a> 375 const uint32_t global_ijk_max[3],

<a id="l00376" name="l00376"></a> 376 const uint32_t local_ijk_min[3],

<a id="l00377" name="l00377"></a> 377 const uint32_t local_ijk_max[3],

<a id="l00378" name="l00378"></a> 378 const float origin[3],

<a id="l00379" name="l00379"></a> 379 const float dir_i[3],

<a id="l00380" name="l00380"></a> 380 const float dir_j[3],

<a id="l00381" name="l00381"></a> 381 const float dir_k[3],

<a id="l00382" name="l00382"></a> 382 const float* i_vals,

<a id="l00383" name="l00383"></a> 383 const float* j_vals,

<a id="l00384" name="l00384"></a> 384 const float* k_vals

<a id="l00385" name="l00385"></a> 385 ) = 0;

<a id="l00386" name="l00386"></a> 386 

<a id="l00415" name="l00415"></a>[ 415](class_d_v_s_1_1_i_client.xhtml#aee6c79370e423a70f4b73c08794cdf9b) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_nodes\_structured](class_d_v_s_1_1_i_client.xhtml#aee6c79370e423a70f4b73c08794cdf9b)

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

<a id="l00417" name="l00417"></a> 417 uint32_t part_id,

<a id="l00418" name="l00418"></a> 418 const uint32_t global_ijk_max[3],

<a id="l00419" name="l00419"></a> 419 const uint32_t local_ijk_min[3],

<a id="l00420" name="l00420"></a> 420 const uint32_t local_ijk_max[3],

<a id="l00421" name="l00421"></a> 421 const float* x_vals,

<a id="l00422" name="l00422"></a> 422 const float* y_vals,

<a id="l00423" name="l00423"></a> 423 const float* z_vals

<a id="l00424" name="l00424"></a> 424 ) = 0;

<a id="l00425" name="l00425"></a> 425 

<a id="l00439" name="l00439"></a>[ 439](class_d_v_s_1_1_i_client.xhtml#a41aa2ad12fbfa456f3ec8e48530ea6f6) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_elements](class_d_v_s_1_1_i_client.xhtml#a41aa2ad12fbfa456f3ec8e48530ea6f6)(uint32_t part_id, [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) type, const uint32_t* indices, uint32_t num_indices) = 0;

<a id="l00440" name="l00440"></a> 440 

<a id="l00458" name="l00458"></a>[ 458](class_d_v_s_1_1_i_client.xhtml#ac6b3990562f507eda4abedf53e021647) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_elements\_polygon](class_d_v_s_1_1_i_client.xhtml#ac6b3990562f507eda4abedf53e021647)

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

<a id="l00460" name="l00460"></a> 460 uint32_t part_id,

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

<a id="l00462" name="l00462"></a> 462 const uint32_t* nodes_per_polygon,

<a id="l00463" name="l00463"></a> 463 uint32_t nodes_per_polygon_size,

<a id="l00464" name="l00464"></a> 464 const uint32_t* indices,

<a id="l00465" name="l00465"></a> 465 uint32_t indices_size

<a id="l00466" name="l00466"></a> 466 ) = 0;

<a id="l00467" name="l00467"></a> 467 

<a id="l00481" name="l00481"></a>[ 481](class_d_v_s_1_1_i_client.xhtml#a7a9ccf04ed8502d23913d8eef21607ec) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_elements\_polyhedral](class_d_v_s_1_1_i_client.xhtml#a7a9ccf04ed8502d23913d8eef21607ec)

<a id="l00482" name="l00482"></a> 482 (

<a id="l00483" name="l00483"></a> 483 uint32_t part_id,

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

<a id="l00485" name="l00485"></a> 485 const uint32_t* faces_per_element,

<a id="l00486" name="l00486"></a> 486 uint32_t faces_per_element_size,

<a id="l00487" name="l00487"></a> 487 const uint32_t* nodes_per_face,

<a id="l00488" name="l00488"></a> 488 uint32_t nodes_per_face_size,

<a id="l00489" name="l00489"></a> 489 const uint32_t* indices,

<a id="l00490" name="l00490"></a> 490 uint32_t indices_size

<a id="l00491" name="l00491"></a> 491 ) = 0;

<a id="l00492" name="l00492"></a> 492 

<a id="l00493" name="l00493"></a> 493 

<a id="l00503" name="l00503"></a>[ 503](class_d_v_s_1_1_i_client.xhtml#a8f2e7174f9e89ef5285043dd9357f9b0) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_var\_case](class_d_v_s_1_1_i_client.xhtml#a8f2e7174f9e89ef5285043dd9357f9b0)([dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) var_type, uint32_t var_id, const float* values, uint32_t num_values) = 0;

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

<a id="l00515" name="l00515"></a>[ 515](class_d_v_s_1_1_i_client.xhtml#ab18cc3827eda737ea73c31aa7fe6ef68) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_var\_part](class_d_v_s_1_1_i_client.xhtml#ab18cc3827eda737ea73c31aa7fe6ef68)([dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;

<a id="l00516" name="l00516"></a> 516 

<a id="l00528" name="l00528"></a>[ 528](class_d_v_s_1_1_i_client.xhtml#aec8ed14b290237049976f68cb81b200f) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_var\_element](class_d_v_s_1_1_i_client.xhtml#aec8ed14b290237049976f68cb81b200f)([dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) elem_type, [dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;

<a id="l00529" name="l00529"></a> 529 

<a id="l00540" name="l00540"></a>[ 540](class_d_v_s_1_1_i_client.xhtml#ae67a2884dd8f68f4757d8d7fac3828d3) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_var\_node](class_d_v_s_1_1_i_client.xhtml#ae67a2884dd8f68f4757d8d7fac3828d3)([dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;

<a id="l00541" name="l00541"></a> 541 

<a id="l00554" name="l00554"></a>[ 554](class_d_v_s_1_1_i_client.xhtml#a3834c25cf5ed35a17f08ecefa4b73417) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_var\_field](class_d_v_s_1_1_i_client.xhtml#a3834c25cf5ed35a17f08ecefa4b73417)([dvs\_var\_location](dynamic__visualization__store__enums_8h.xhtml#af4f0eba512eff253854b44d7ce078491) location, [dvs\_element\_type](dynamic__visualization__store__enums_8h.xhtml#af1c8824b29a0ab747460216716cc2895) elem_type, [dvs\_var\_type](dynamic__visualization__store__enums_8h.xhtml#af6aa6351345da4151507012681b3aff0) var_type, uint32_t var_id, uint32_t part_id, const float* values, uint32_t num_values) = 0;

<a id="l00555" name="l00555"></a> 555 

<a id="l00565" name="l00565"></a>[ 565](class_d_v_s_1_1_i_client.xhtml#afcf7811f22d58bd328bed415116a4c41) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [update\_plot](class_d_v_s_1_1_i_client.xhtml#afcf7811f22d58bd328bed415116a4c41)(uint32_t plot_id, const float* x_values, const float* y_values, uint32_t num_values) = 0;

<a id="l00566" name="l00566"></a> 566 

<a id="l00572" name="l00572"></a>[ 572](class_d_v_s_1_1_i_client.xhtml#a6396cc4ae967ad5f0da8e234429a97cd) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [end\_update](class_d_v_s_1_1_i_client.xhtml#a6396cc4ae967ad5f0da8e234429a97cd)() = 0;

<a id="l00573" name="l00573"></a> 573 

<a id="l00592" name="l00592"></a>[ 592](class_d_v_s_1_1_i_client.xhtml#a5e8f192f5c683a8265dd94020506a0aa) virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [delete\_item](class_d_v_s_1_1_i_client.xhtml#a5e8f192f5c683a8265dd94020506a0aa)(uint32_t update_num, uint32_t rank, const char* filter) = 0;

<a id="l00593" name="l00593"></a> 593 };

<a id="l00594" name="l00594"></a> 594 

<a id="l00603" name="l00603"></a>[ 603](dvs__client__interface_8h.xhtml#ab009ac80464841b8563982bafba05f14) DVS_DLL_EXPORT [DVS::IClient](class_d_v_s_1_1_i_client.xhtml)* [CREATE\_CLIENT\_INSTANCE](dvs__client__interface_8h.xhtml#ab009ac80464841b8563982bafba05f14)([DVS::IServer](class_d_v_s_1_1_i_server.xhtml)* server, [dvs\_client\_flags](dynamic__visualization__store__enums_8h.xhtml#aec8cbac60b9cafe5d1c0ad6593f05e9f) flags, const char* secret);

<a id="l00604" name="l00604"></a> 604 

<a id="l00610" name="l00610"></a>[ 610](dvs__client__interface_8h.xhtml#a3f13d009a9a07278cbca3449113d78fc) DVS_DLL_EXPORT void [DESTROY\_CLIENT\_INSTANCE](dvs__client__interface_8h.xhtml#a3f13d009a9a07278cbca3449113d78fc)([DVS::IClient](class_d_v_s_1_1_i_client.xhtml)* destroy);

<a id="l00611" name="l00611"></a> 611 }

<a id="l00612" name="l00612"></a> 612 

<a id="l00613" name="l00613"></a> 613 \#endif //\_\_\_DVS\_DYNAMIC\_VISUALIZATION\_STORE\_CLIENT\_INTERFACE\_\_\_

[DVS::IClient](class_d_v_s_1_1_i_client.xhtml)

API for solvers to use to send data to EnSight servers.

**Definition:** [dvs\_client\_interface.h:81](dvs__client__interface_8h_source.xhtml#l00080)



[DVS::IClient::set\_logger](class_d_v_s_1_1_i_client.xhtml#a024475b03496bc310e211632d153517d)

virtual void set_logger(ILogger *logger)=0

Set the logger interface to use.



[DVS::IClient::operator=](class_d_v_s_1_1_i_client.xhtml#a06c322b0c109e9fe8de05b8991d638e0)

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

default



[DVS::IClient::update\_nodes\_structured](class_d_v_s_1_1_i_client.xhtml#a1588c437020e0ba5702ec48460a792a9)

virtual dvs_ret update_nodes_structured(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)=0

Update the nodes for a parallelepiped structured part.



[DVS::IClient::add\_plot\_info](class_d_v_s_1_1_i_client.xhtml#a1bdb7ca9cf25c63e533f47fe26132af6)

virtual dvs_ret add_plot_info(const dvs_plot_info *plot_info, uint32_t num_plots)=0

Add plot information for session.



[DVS::IClient::get\_var\_info](class_d_v_s_1_1_i_client.xhtml#a2749739390de2501b4ae4de0ad878703)

virtual const dvs_var_info * get_var_info(uint32_t index) const =0

Get the dvs_var_info object for a specific index.



[DVS::IClient::set\_unit\_system](class_d_v_s_1_1_i_client.xhtml#a284f922fec402e03365c7873502d1fde)

virtual dvs_ret set_unit_system(const char *system)=0

Set the unit system we are using for this session (optional)



[DVS::IClient::IClient](class_d_v_s_1_1_i_client.xhtml#a3833003a214593bcf229917fe9f677d0)

IClient(IClient &amp;&amp;)=default

default



[DVS::IClient::update\_var\_field](class_d_v_s_1_1_i_client.xhtml#a3834c25cf5ed35a17f08ecefa4b73417)

virtual dvs_ret update_var_field(dvs_var_location location, dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float *values, uint32_t num_values)=0

Update var field values (nodal or elemental)



[DVS::IClient::update\_elements](class_d_v_s_1_1_i_client.xhtml#a41aa2ad12fbfa456f3ec8e48530ea6f6)

virtual dvs_ret update_elements(uint32_t part_id, dvs_element_type type, const uint32_t *indices, uint32_t num_indices)=0

Update elements for a specific part and element type.



[DVS::IClient::get\_part\_id](class_d_v_s_1_1_i_client.xhtml#a4e3e6fbf66582927a17b54c9fba3464c)

virtual dvs_ret get_part_id(const std::string &amp;name, uint32_t &amp;id) const =0

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



[DVS::IClient::get\_plot\_id](class_d_v_s_1_1_i_client.xhtml#a5dc7f1a7c19c068b04a384c1891e435f)

virtual dvs_ret get_plot_id(const std::string &amp;name, uint32_t &amp;id) const =0

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



[DVS::IClient::delete\_item](class_d_v_s_1_1_i_client.xhtml#a5e8f192f5c683a8265dd94020506a0aa)

virtual dvs_ret delete_item(uint32_t update_num, uint32_t rank, const char *filter)=0

Delete an item.



[DVS::IClient::add\_part\_info](class_d_v_s_1_1_i_client.xhtml#a5e9ee6af237e76a6e270d99ec8cd4388)

virtual dvs_ret add_part_info(const dvs_part_info *part_info, uint32_t num_parts)=0

Add part information for session.



[DVS::IClient::end\_update](class_d_v_s_1_1_i_client.xhtml#a6396cc4ae967ad5f0da8e234429a97cd)

virtual dvs_ret end_update()=0

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



[DVS::IClient::IClient](class_d_v_s_1_1_i_client.xhtml#a64eedec7e83a7e05ae9b3ca96c9f79b6)

IClient()=default

default



[DVS::IClient::operator=](class_d_v_s_1_1_i_client.xhtml#a738cf29fb146b4c56e81e25954855b92)

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

default



[DVS::IClient::update\_elements\_polyhedral](class_d_v_s_1_1_i_client.xhtml#a7a9ccf04ed8502d23913d8eef21607ec)

virtual dvs_ret update_elements_polyhedral(uint32_t part_id, 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)=0

Update N-FACED Elements.



[DVS::IClient::IClient](class_d_v_s_1_1_i_client.xhtml#a7cf4e8dfda9a6d9de1ab8ca4ea64961f)

IClient(const IClient &amp;)=default

support copying



[DVS::IClient::get\_num\_plots](class_d_v_s_1_1_i_client.xhtml#a80325aaa83f2d2f27f1aa8e5f167c4c6)

virtual uint32_t get_num_plots() const =0

Get the number of dvs_plot_info objects this client has stored.



[DVS::IClient::add\_var\_info](class_d_v_s_1_1_i_client.xhtml#a82f841d7f6f33071bf8c709623ca215d)

virtual dvs_ret add_var_info(const dvs_var_info *var_info, uint32_t num_vars)=0

Add variable information for session.



[DVS::IClient::get\_num\_vars](class_d_v_s_1_1_i_client.xhtml#a85adbf75ade9d0ffc6d258c34dae1eb3)

virtual uint32_t get_num_vars() const =0

Get the number of dvs_var_info objects this client has stored.



[DVS::IClient::update\_nodes](class_d_v_s_1_1_i_client.xhtml#a87ab36c2f16d093c0beaba60da2cd661)

virtual dvs_ret update_nodes(uint32_t part_id, const float *x, const float *y, const float *z, uint32_t num_values)=0

Update nodes for a specific part.



[DVS::IClient::update\_var\_case](class_d_v_s_1_1_i_client.xhtml#a8f2e7174f9e89ef5285043dd9357f9b0)

virtual dvs_ret update_var_case(dvs_var_type var_type, uint32_t var_id, const float *values, uint32_t num_values)=0

Update case variable.



[DVS::IClient::end\_init](class_d_v_s_1_1_i_client.xhtml#aaf1641a1afbf8bb6257940be28dd94b2)

virtual dvs_ret end_init()=0

Finish initialization for this rank.



[DVS::IClient::update\_var\_part](class_d_v_s_1_1_i_client.xhtml#ab18cc3827eda737ea73c31aa7fe6ef68)

virtual dvs_ret update_var_part(dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float *values, uint32_t num_values)=0

Update part vector variable.



[DVS::IClient::add\_metadata](class_d_v_s_1_1_i_client.xhtml#ab4144e59bfdcf9c095c6510c4298d160)

virtual dvs_ret add_metadata(const char *const keys[], const char *const vals[], uint32_t num_metadata_pairs)=0

Add metadata for the current dataset.



[DVS::IClient::~IClient](class_d_v_s_1_1_i_client.xhtml#ab54b2523137180da43fa39b2e597eb0d)

virtual ~IClient()=default

default



[DVS::IClient::begin\_update](class_d_v_s_1_1_i_client.xhtml#abd1cbbd2007346ad616dc74eab9d0553)

virtual dvs_ret begin_update(uint32_t update_num, uint32_t rank, uint32_t chunk, float time)=0

Method to begin an update.



[DVS::IClient::get\_var\_id](class_d_v_s_1_1_i_client.xhtml#ac4a86f03c9eb353cb1d92e326945cb9c)

virtual dvs_ret get_var_id(const std::string &amp;name, uint32_t &amp;id) const =0

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



[DVS::IClient::get\_version](class_d_v_s_1_1_i_client.xhtml#ac65e50e425b440f4b84dd1decc3478c9)

virtual const char * get_version()=0

Get the version of the client API.



[DVS::IClient::update\_elements\_polygon](class_d_v_s_1_1_i_client.xhtml#ac6b3990562f507eda4abedf53e021647)

virtual dvs_ret update_elements_polygon(uint32_t part_id, dvs_element_type type, const uint32_t *nodes_per_polygon, uint32_t nodes_per_polygon_size, const uint32_t *indices, uint32_t indices_size)=0

Update N-SIDED elements.



[DVS::IClient::get\_plot\_info](class_d_v_s_1_1_i_client.xhtml#ac9690e1df7282cfde97d8a27a1438bb2)

virtual const dvs_plot_info * get_plot_info(uint32_t index) const =0

Get the dvs_plot_info object for a specific index.



[DVS::IClient::update\_var\_node](class_d_v_s_1_1_i_client.xhtml#ae67a2884dd8f68f4757d8d7fac3828d3)

virtual dvs_ret update_var_node(dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float *values, uint32_t num_values)=0

Update nodal variable values.



[DVS::IClient::update\_var\_element](class_d_v_s_1_1_i_client.xhtml#aec8ed14b290237049976f68cb81b200f)

virtual dvs_ret update_var_element(dvs_element_type elem_type, dvs_var_type var_type, uint32_t var_id, uint32_t part_id, const float *values, uint32_t num_values)=0

Update elemental scalar variable values.



[DVS::IClient::update\_nodes\_structured](class_d_v_s_1_1_i_client.xhtml#aee6c79370e423a70f4b73c08794cdf9b)

virtual dvs_ret update_nodes_structured(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)=0

Update the nodes for a curvilinear structured part.



[DVS::IClient::get\_num\_parts](class_d_v_s_1_1_i_client.xhtml#af609f80df51a124a137c6476b7d3c958)

virtual uint32_t get_num_parts() const =0

Get the number of dvs_part_info objects this client has stored.



[DVS::IClient::get\_part\_info](class_d_v_s_1_1_i_client.xhtml#af96a3f9cef0204d8c04032e9ce3e3f59)

virtual const dvs_part_info * get_part_info(uint32_t index) const =0

Get the dvs_part_info object for a specific index.



[DVS::IClient::update\_plot](class_d_v_s_1_1_i_client.xhtml#afcf7811f22d58bd328bed415116a4c41)

virtual dvs_ret update_plot(uint32_t plot_id, const float *x_values, const float *y_values, uint32_t num_values)=0

Update plot data for plot.



[DVS::IClient::begin\_init](class_d_v_s_1_1_i_client.xhtml#aff782ecd341fddd87a22a15107efeb3b)

virtual dvs_ret begin_init(const char *dataset_name, uint32_t current_rank, uint32_t total_ranks, uint32_t num_chunks)=0

Begins initialization for this rank.



[DVS::ILogger](class_d_v_s_1_1_i_logger.xhtml)

Interface for a logger to be used by DVS::IClient.

**Definition:** [logger\_interface.h:35](logger__interface_8h_source.xhtml#l00034)



[DVS::IServer](class_d_v_s_1_1_i_server.xhtml)

Interface class used to run a dynamic data server in a thread accepting incoming client connections.

**Definition:** [dvs\_server\_interface.h:57](dvs__server__interface_8h_source.xhtml#l00056)



[DVS::DESTROY\_CLIENT\_INSTANCE](dvs__client__interface_8h.xhtml#a3f13d009a9a07278cbca3449113d78fc)

DVS_DLL_EXPORT void DESTROY_CLIENT_INSTANCE(DVS::IClient *destroy)

Destruction method for a client created with CREATE_CLIENT_INSTANCE.



[DVS::CREATE\_CLIENT\_INSTANCE](dvs__client__interface_8h.xhtml#ab009ac80464841b8563982bafba05f14)

DVS_DLL_EXPORT DVS::IClient * CREATE_CLIENT_INSTANCE(DVS::IServer *server, dvs_client_flags flags, const char *secret)

Factory method to create a dynamic data client interface instance.



[dvs\_server\_interface.h](dvs__server__interface_8h.xhtml)

C++ Server API for using Dynamic Visualization Store Server.



[dynamic\_visualization\_store\_api.h](dynamic__visualization__store__api_8h.xhtml)

C API for using Dynamic Visualization Store.



[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:193](dynamic__visualization__store__enums_8h_source.xhtml#l00193)



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



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



[logger\_interface.h](logger__interface_8h.xhtml)

Logger Interface Class.



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