## On this page
# DVS::IPlotChunk Class Reference
Last update: 16.07.2025
`#include <dvs_plot_chunk_interface.h>`
Inheritance diagram for DVS::IPlotChunk:
## Public Member Functions
**IPlotChunk** ()=default virtual **~IPlotChunk** ()=default **IPlotChunk** ([IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &&)=default [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) & **operator=** ([IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &&)=default **IPlotChunk** (const [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &)=default [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) & **operator=** (const [IPlotChunk](class_d_v_s_1_1_i_plot_chunk.xhtml) &)=default virtual float [get\_time](#ad9ff283c65e3a3ca1833fa95739cefbb) () const =0 virtual uint32\_t [get\_rank](#ac8cfe243352cdc8d6882f521a6382df6) () const =0 virtual const [DVS::IObject](class_d_v_s_1_1_i_object.xhtml) \* [get\_object](#a3eaf3659a02d09c641ba70a1a402053b) () const =0 virtual [dvs\_ret](dynamic__visualization__store__error__codes_8h.xhtml#a1d7466ae72e89fe36cbf2408b4f7d9c1) [get\_data](#a9dd0631a3b7c171a8593289cc7aa84b3) (uint32\_t \*num\_values, float \*x\_axis\_values, float \*y\_axis\_values)=0  Public Member Functions inherited from [DVS::IHash](class_d_v_s_1_1_i_hash.xhtml) **IHash** ()=default virtual **~IHash** ()=default **IHash** ([IHash](class_d_v_s_1_1_i_hash.xhtml) &&)=default [IHash](class_d_v_s_1_1_i_hash.xhtml) & **operator=** ([IHash](class_d_v_s_1_1_i_hash.xhtml) &&)=default **IHash** (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &)=default [IHash](class_d_v_s_1_1_i_hash.xhtml) & **operator=** (const [IHash](class_d_v_s_1_1_i_hash.xhtml) &)=default virtual uint32\_t [get\_hash\_size](class_d_v_s_1_1_i_hash.xhtml#ac0dedeb8d9dfd442d49d16cb4ddfb221) () const =0 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 ## Detailed Description
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()](#a3eaf3659a02d09c641ba70a1a402053b "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
## [◆ ](#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->get\_data(&axis\_size, nullptr, nullptr)) { std::vector<float> x\_values(axis\_size); std::vector<float> y\_values(axis\_size); plot->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
## [◆ ](#a3eaf3659a02d09c641ba70a1a402053b)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
## [◆ ](#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)
## [◆ ](#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/Product-src/ensight/user\_defined\_src/readers/dvs/include/[dvs\_plot\_chunk\_interface.h](dvs__plot__chunk__interface_8h_source.xhtml)