Post-processing tools 2024 R2

DVS::IDataset Class Reference

Last update: 16.07.2025

#include <dvs_dataset_interface.h>

Inheritance diagram for DVS::IDataset:
DVS::IObject

Public Member Functions

 IDataset ()=default
 
virtual ~IDataset ()=default
 
 IDataset (IDataset &&)=default
 
IDataset & operator= (IDataset &&)=default
 
 IDataset (const IDataset &)=default
 
IDataset & operator= (const IDataset &)=default
 
virtual const char * get_unit_system () const =0
 
virtual uint32_t get_num_ranks () const =0
 
virtual dvs_ret get_ranks (uint32_t *ranks) const =0
 
virtual uint32_t get_num_chunks_per_rank () const =0
 
virtual dvs_ret get_chunks_per_rank (uint32_t *chunks_per_rank) const =0
 
virtual uint32_t get_num_parts () const =0
 
virtual const DVS::IObject * get_part (uint32_t index) const =0
 
virtual uint32_t get_num_plots () const =0
 
virtual const DVS::IObject * get_plot (uint32_t index) const =0
 
virtual uint32_t get_num_variables () const =0
 
virtual const DVS::IVar * get_var (uint32_t index) const =0
 
- Public Member Functions inherited from DVS::IObject
 IObject ()=default
 
virtual ~IObject ()=default
 
 IObject (IObject &&)=default
 
IObject & operator= (IObject &&)=default
 
 IObject (const IObject &)=default
 
IObject & operator= (const IObject &)=default
 
virtual const char * get_name () const =0
 
virtual ObjectDefType get_type () const =0
 
virtual const DVS::IDataset * get_dataset () const =0
 
virtual uint32_t get_num_metadata () const =0
 
virtual const char * get_metadata_key (uint32_t index) const =0
 
virtual const char * get_metadata_value (uint32_t index) const =0
 
virtual const char * get_metadata_value (const char *key) const =0
 

Additional Inherited Members

- Public Types inherited from DVS::IObject
enum  ObjectDefType { PART , PLOT , CASE }
 

Detailed Description

This object's lifetime is controlled by the query it is returned from. If the filter or uri of the query is changed this object will be destroyed. If this is a chained query and any of the parent queries are modified this object will also be destroyed. See dvs_query_interface.h for more information.

Definition at line 43 of file dvs_dataset_interface.h.

Member Function Documentation

◆ get_chunks_per_rank()

virtual dvs_ret DVS::IDataset::get_chunks_per_rank ( uint32_t *  chunks_per_rank) const
pure virtual

Get the number of chunks for each rank.

This method returns an array of the max number of chunks for each rank based on the filters of the query. The values correspond to the ranks returned from IDataset::get_ranks(). Example: if get_ranks returns ranks: [0 2 5] then this might return [1 1 2] based on the number of chunks this dataset was written with.

Parameters
chunks_per_rankbuffer of size DVS::IDataset::get_num_chunks_per_rank(), returns the number of chunks for each rank for this query/dataset
Returns
dvs_ret DVS_NONE if no errors, otherwise see dynamic_visualization_store_error_codes.h

◆ get_num_chunks_per_rank()

virtual uint32_t DVS::IDataset::get_num_chunks_per_rank ( ) const
pure virtual

Get the size of the chunks_per_rank array for get_chunks_per_rank()

The size of this should match the number of ranks this dataset has

Returns
uint32_t the number of chunks per ranks

◆ get_num_parts()

virtual uint32_t DVS::IDataset::get_num_parts ( ) const
pure virtual

Get the number of parts for this dataset.

Returns
uint32_t the number of parts

◆ get_num_plots()

virtual uint32_t DVS::IDataset::get_num_plots ( ) const
pure virtual

Get the number of plots for this datasets.

Returns
uint32_t the number of plots for this dataset

◆ get_num_ranks()

virtual uint32_t DVS::IDataset::get_num_ranks ( ) const
pure virtual

Get the number of ranks for the dataset.

Returns
uint32_t number of ranks

◆ get_num_variables()

virtual uint32_t DVS::IDataset::get_num_variables ( ) const
pure virtual

Get the number of variables for this dataset.

Returns
uint32_t the number of variable definitions

◆ get_part()

virtual const DVS::IObject * DVS::IDataset::get_part ( uint32_t  index) const
pure virtual

Get a part by index.

Parameters
indexindex of the part
Returns
DVS::IObject* pointer to part object or nullptr if not found

◆ get_plot()

virtual const DVS::IObject * DVS::IDataset::get_plot ( uint32_t  index) const
pure virtual

Get the plot object.

Parameters
indexthe index of the plot to retrieve
Returns
DVS::IObject* pointer to DVS::IObject plot or nullptr

◆ get_ranks()

virtual dvs_ret DVS::IDataset::get_ranks ( uint32_t *  ranks) const
pure virtual

Get an array of the ranks for this dataset query.

This method returns an array of the rank numbers for this dataset based on the query

Parameters
[out]ranksbuffer of size DVS::IDataset::get_num_ranks(), the ranks avaialble for this query/dataset
Returns
dvs_ret DVS_NONE if no errors, otherwise see dynamic_visualization_store_error_codes.h

◆ get_unit_system()

virtual const char * DVS::IDataset::get_unit_system ( ) const
pure virtual

Get the unit system of the dataset.

Returns
const char* unit system of the dataset

◆ get_var()

virtual const DVS::IVar * DVS::IDataset::get_var ( uint32_t  index) const
pure virtual

Get the var object.

Parameters
indexthe index of the var to retrieve
Returns
DVS::IVar* pointer to DVS::IVar object or nullptr
The documentation for this class was generated from the following file:

Connect with Ansys