    

 ## On this page

  

 

 # DVS::IPlotChunk Class Reference

 Last update: 16.07.2025 

Plot Chunk Interface for DVS Reader API. [More...](class_d_v_s_1_1_i_plot_chunk.xhtml#details)

`#include <<a class="el" href="dvs__plot__chunk__interface_8h_source.xhtml">dvs_plot_chunk_interface.h</a>>`

Inheritance diagram for DVS::IPlotChunk:

 ![](/sites/default/files/migrate-content/tools_for_ensight_post_processing_import/class_d_v_s_1_1_i_plot_chunk.png)



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

<a id="acfaef90506b504a098bd4d524ba3aaac"></a> [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml#acfaef90506b504a098bd4d524ba3aaac) ()=default default   
 <a id="ad1a21b9cbe0c9362196cb707c4041306"></a>virtual [~IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml#ad1a21b9cbe0c9362196cb707c4041306) ()=default default   
 <a id="a4aa8324189293247b37d95b554a1cdb3"></a> [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml#a4aa8324189293247b37d95b554a1cdb3) ([IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp;&amp;)=default default   
 <a id="a963e7830a9621a0119eea1959c2987c8"></a>[IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp; [operator=](class_d_v_s_1_1_i_plot_chunk.xhtml#a963e7830a9621a0119eea1959c2987c8) ([IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp;&amp;)=default default   
 <a id="a77c7e11b63c01b975e1e8f14aa594989"></a> [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml#a77c7e11b63c01b975e1e8f14aa594989) (const [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp;)=default support copying   
 <a id="a66e93a4d136c4b09bff1982fef630171"></a>[IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp; [operator=](class_d_v_s_1_1_i_plot_chunk.xhtml#a66e93a4d136c4b09bff1982fef630171) (const [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &amp;)=default default   
 virtual float [get\_time](class_d_v_s_1_1_i_plot_chunk.xhtml#ad9ff283c65e3a3ca1833fa95739cefbb) () const =0 Get the time for this plot. [More...](class_d_v_s_1_1_i_plot_chunk.xhtml#ad9ff283c65e3a3ca1833fa95739cefbb)  
 virtual uint32\_t [get\_rank](class_d_v_s_1_1_i_plot_chunk.xhtml#ac8cfe243352cdc8d6882f521a6382df6) () const =0 Get the rank for the plot. [More...](class_d_v_s_1_1_i_plot_chunk.xhtml#ac8cfe243352cdc8d6882f521a6382df6)  
 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* [get\_object](class_d_v_s_1_1_i_plot_chunk.xhtml#ab4fa87c643cc373f57ae307d1b28a2de) () const =0 Get the plot definition this plot chunk is associated with. [More...](class_d_v_s_1_1_i_plot_chunk.xhtml#ab4fa87c643cc373f57ae307d1b28a2de)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_data](class_d_v_s_1_1_i_plot_chunk.xhtml#a9dd0631a3b7c171a8593289cc7aa84b3) (uint32\_t \*num\_values, float \*x\_axis\_values, float \*y\_axis\_values)=0 Get data for plot chunk. [More...](class_d_v_s_1_1_i_plot_chunk.xhtml#a9dd0631a3b7c171a8593289cc7aa84b3)  
 ![-](/sites/default/files/migrate-content/tools_for_ensight_post_processing_import/closed.png) Public Member Functions inherited from [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml)<a id="a2f73d1292c0162a03bd29e9094567a77"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a2f73d1292c0162a03bd29e9094567a77) ()=default default   
 <a id="a2e08d37be2095880bcb7d77b365ebde3"></a>virtual [~IHash](class_d_v_s_1_1_i_hash.xhtml#a2e08d37be2095880bcb7d77b365ebde3) ()=default default   
 <a id="a41019f8e16b485b73c1a832df9c21665"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a41019f8e16b485b73c1a832df9c21665) ([IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;&amp;)=default default   
 <a id="ac5648bfca884e7946ca52f2da177f872"></a>[IHash](class_d_v_s_1_1_i_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_hash.xhtml#ac5648bfca884e7946ca52f2da177f872) ([IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;&amp;)=default default   
 <a id="a17952af3cbc7170e37f882b17e800b3f"></a> [IHash](class_d_v_s_1_1_i_hash.xhtml#a17952af3cbc7170e37f882b17e800b3f) (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;)=default support copying   
 <a id="a31c93a2f7434c7e478289086bbb031b0"></a>[IHash](class_d_v_s_1_1_i_hash.xhtml) &amp; [operator=](class_d_v_s_1_1_i_hash.xhtml#a31c93a2f7434c7e478289086bbb031b0) (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &amp;)=default default   
 virtual uint32\_t [get\_hash\_size](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221) () const =0 Get the size of the hash to use with [IHash::get\_hash()](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874 "Get the hash of the data.") [More...](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221)  
 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_hash](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874) (char \*hash) const =0 Get the hash of the data. [More...](class_d_v_s_1_1_i_hash.xhtml#a51eaee86a6e2db4dda7f4326daa33874)  
 <a id="details" name="details"></a>## Detailed Description

Plot Chunk Interface for DVS Reader API.

A Plot Chunk in DVS contains the x/y coordinates for a specific timestep. In general there is only 1 of these across all ranks for a specific time as plots aren't spatially decomposed. Variable information is stored in metadata attached to the referenced plot object. See [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml "Interface to get hash information from DVS objects.") for the hash object interface.

Axis title/unit information is stored in metadata on the [DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.") interface from [IPlotChunk::get\_object()](class_d_v_s_1_1_i_plot_chunk.xhtml#ab4fa87c643cc373f57ae307d1b28a2de "Get the plot definition this plot chunk is associated with.")

Definition at line [50](dvs__plot__chunk__interface_8h_source.xhtml#l00050) of file [dvs\_plot\_chunk\_interface.h](dvs__plot__chunk__interface_8h_source.xhtml).



## Member Function Documentation

<a id="a9dd0631a3b7c171a8593289cc7aa84b3"></a>## [◆ ](#a9dd0631a3b7c171a8593289cc7aa84b3)get\_data()

 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) DVS::IPlotChunk::get\_data  ( uint32\_t \*  *num\_values*,    float \*  *x\_axis\_values*,    float \*  *y\_axis\_values*   )   pure virtual 

Get data for plot chunk.

This method retrieves data for the plot chunk. It should be first called with non nullptr num\_values to get the size of the individual x and y axis values arrays. Example usage: [DVS::IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml "Plot Chunk Interface for DVS Reader API.")\* plot = //get object instance uint32\_t axis\_size = 0; if (DVS\_NONE == plot-&gt;get\_data(&amp;axis\_size, nullptr, nullptr)) { std::vector&lt;float&gt; x\_values(axis\_size); std::vector&lt;float&gt; y\_values(axis\_size); plot-&gt;get\_data(nullptr, x\_values.data(), y\_values.data()); }

Error Codes:

- DVS\_NONE: No error
- DVS\_NO\_DATA: Object has no data, should not happen through DVS Reader API
- DVS\_PARAM\_NULL: All parameters are null. Method will do nothing.
- DVS\_INVALID\_CACHE: Loading cache failed, possibly invalid cache or invalid permissions
- DVS\_DATA\_FAILED\_LOAD: There was a failure loading data, data is either empty or missing
- DVS\_INVALID\_HASH: Hash of variable data is invalid. There is a problem with the data

Parameters \[out\]num\_valuesif not nullptr returns the number of values for each axis \[out\]x\_axis\_valuesif not nullptr the x axis values, must be of size num\_values \[out\]y\_axis\_valuesif not nullptr the y axis values, must be of size num\_values Returnsdvs\_ret DVS\_NONE on no error, see the method description for errors 



<a id="ab4fa87c643cc373f57ae307d1b28a2de"></a>## [◆ ](#ab4fa87c643cc373f57ae307d1b28a2de)get\_object()

 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml)\* DVS::IPlotChunk::get\_object  ( )  const  pure virtual 

Get the plot definition this plot chunk is associated with.

Returnsconst [DVS::IObject](class_d_v_s_1_1_i_object.xhtml "Interface for part/plot objects for DVS Reader API.")\* the object definition 



<a id="ac8cfe243352cdc8d6882f521a6382df6"></a>## [◆ ](#ac8cfe243352cdc8d6882f521a6382df6)get\_rank()

 virtual uint32\_t DVS::IPlotChunk::get\_rank  ( )  const  pure virtual 

Get the rank for the plot.

Plots are generally sent by 1 rank. Specific plots can be sent from different ranks but across ranks only 1 rank should send plot data for a specific time and plot.

Returnsuint32\_t the rank this plot is assocaited with (zero based) 



<a id="ad9ff283c65e3a3ca1833fa95739cefbb"></a>## [◆ ](#ad9ff283c65e3a3ca1833fa95739cefbb)get\_time()

 virtual float DVS::IPlotChunk::get\_time  ( )  const  pure virtual 

Get the time for this plot.

Returnsfloat the time this plot is associated with 



---

The documentation for this class was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/user\_defined\_src/readers/dvs/include/[dvs\_plot\_chunk\_interface.h](dvs__plot__chunk__interface_8h_source.xhtml)