Skip to main content

Post-processing tools 2023 R2

dvs_dataset_interface.h

Last update: 17.04.2023
Go to the documentation of this file.
1 /**************************************************************
2 *
3 * (C) 2021 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.
4 *
5 * Restricted Rights Legend
6 *
7 * Use, duplication, or disclosure of this
8 * software and its documentation by the
9 * Government is subject to restrictions as
10 * set forth in subdivision [(b)(3)(ii)] of
11 * the Rights in Technical Data and Computer
12 * Software clause at 52.227-7013.
13 *
14 **************************************************************
15 */
16 
23 #ifndef ___DVS_DATASET_INTERFACE_H___
24 #define ___DVS_DATASET_INTERFACE_H___
25 
28 
29 #include "dvs_object_interface.h"
30 #include "dvs_var_interface.h"
31 
32 namespace DVS
33 {
34 
43 class IDataset : public IObject
44 {
45 public:
46 
47  IDataset() = default;
48  virtual ~IDataset() = default;
49  IDataset(IDataset&&) = default;
50  IDataset& operator=(IDataset&&) = default;
51  IDataset(const IDataset&) = default;
52  IDataset& operator=(const IDataset&) = default;
53 
59  virtual const char* get_unit_system() const = 0;
60 
66  virtual uint32_t get_num_ranks() const = 0;
67 
76  virtual dvs_ret get_ranks(uint32_t* ranks) const = 0;
77 
85  virtual uint32_t get_num_chunks_per_rank() const = 0;
86 
99  virtual dvs_ret get_chunks_per_rank(uint32_t* chunks_per_rank) const = 0;
100 
106  virtual uint32_t get_num_parts() const = 0;
107 
114  virtual const DVS::IObject* get_part(uint32_t index) const = 0;
115 
121  virtual uint32_t get_num_plots() const = 0;
122 
129  virtual const DVS::IObject* get_plot(uint32_t index) const = 0;
130 
136  virtual uint32_t get_num_variables() const = 0;
137 
144  virtual const DVS::IVar* get_var(uint32_t index) const = 0;
145 };
146 
147 } //namespace DVS
148 
149 #endif //___DVS_DATASET_INTERFACE_H___
Interface for datasets for the DVS Reader API.
virtual uint32_t get_num_ranks() const =0
Get the number of ranks for the dataset.
virtual const DVS::IObject * get_plot(uint32_t index) const =0
Get the plot object.
virtual uint32_t get_num_plots() const =0
Get the number of plots for this datasets.
IDataset(IDataset &&)=default
default
virtual const DVS::IVar * get_var(uint32_t index) const =0
Get the var object.
virtual const char * get_unit_system() const =0
Get the unit system of the dataset.
virtual uint32_t get_num_chunks_per_rank() const =0
Get the size of the chunks_per_rank array for get_chunks_per_rank()
IDataset()=default
default
virtual uint32_t get_num_parts() const =0
Get the number of parts for this dataset.
virtual ~IDataset()=default
default
IDataset & operator=(IDataset &&)=default
default
IDataset(const IDataset &)=default
support copying
virtual const DVS::IObject * get_part(uint32_t index) const =0
Get a part by index.
virtual dvs_ret get_ranks(uint32_t *ranks) const =0
Get an array of the ranks for this dataset query.
virtual uint32_t get_num_variables() const =0
Get the number of variables for this dataset.
IDataset & operator=(const IDataset &)=default
default
virtual dvs_ret get_chunks_per_rank(uint32_t *chunks_per_rank) const =0
Get the number of chunks for each rank.
Interface for part/plot objects for DVS Reader API.
Interface for variables for the DVS Reader API.
DVS Reader API Object Interface.
DVS Reader API Variable Interface.
Contains enums used in C/C++ API.
Contains errors used in the DVS C/C++ API.
int32_t dvs_ret
Return value of methods, TODO.