DVS::IDataset Class Reference
Last update: 17.04.2023Interface for datasets for the DVS Reader API. More...
#include <dvs_dataset_interface.h>
Public Member Functions | |
| IDataset ()=default | |
| default | |
| virtual | ~IDataset ()=default |
| default | |
| IDataset (IDataset &&)=default | |
| default | |
| IDataset & | operator= (IDataset &&)=default |
| default | |
| IDataset (const IDataset &)=default | |
| support copying | |
| IDataset & | operator= (const IDataset &)=default |
| default | |
| virtual const char * | get_unit_system () const =0 |
| Get the unit system of the dataset. More... | |
| virtual uint32_t | get_num_ranks () const =0 |
| Get the number of ranks for the dataset. More... | |
| virtual dvs_ret | get_ranks (uint32_t *ranks) const =0 |
| Get an array of the ranks for this dataset query. More... | |
| virtual uint32_t | get_num_chunks_per_rank () const =0 |
| Get the size of the chunks_per_rank array for get_chunks_per_rank() More... | |
| virtual dvs_ret | get_chunks_per_rank (uint32_t *chunks_per_rank) const =0 |
| Get the number of chunks for each rank. More... | |
| virtual uint32_t | get_num_parts () const =0 |
| Get the number of parts for this dataset. More... | |
| virtual const DVS::IObject * | get_part (uint32_t index) const =0 |
| Get a part by index. More... | |
| virtual uint32_t | get_num_plots () const =0 |
| Get the number of plots for this datasets. More... | |
| virtual const DVS::IObject * | get_plot (uint32_t index) const =0 |
| Get the plot object. More... | |
| virtual uint32_t | get_num_variables () const =0 |
| Get the number of variables for this dataset. More... | |
| virtual const DVS::IVar * | get_var (uint32_t index) const =0 |
| Get the var object. More... | |
 Public Member Functions inherited from DVS::IObject | |
| IObject ()=default | |
| default | |
| virtual | ~IObject ()=default |
| default | |
| IObject (IObject &&)=default | |
| default | |
| IObject & | operator= (IObject &&)=default |
| default | |
| IObject (const IObject &)=default | |
| support copying | |
| IObject & | operator= (const IObject &)=default |
| default | |
| virtual const char * | get_name () const =0 |
| Get the name of the object. More... | |
| virtual ObjectDefType | get_type () const =0 |
| Get the type of the object. More... | |
| virtual const DVS::IDataset * | get_dataset () const =0 |
| Get the reference dataset for this object. More... | |
| virtual uint32_t | get_num_metadata () const =0 |
| Get the number of metadata objects. More... | |
| virtual const char * | get_metadata_key (uint32_t index) const =0 |
| Get the metadata key by index. More... | |
| virtual const char * | get_metadata_value (uint32_t index) const =0 |
| Get the metadata value by index. More... | |
| virtual const char * | get_metadata_value (const char *key) const =0 |
| Get the metadata value object. More... | |
Additional Inherited Members | |
| Public Types inherited from DVS::IObject | |
| enum | ObjectDefType { PART , PLOT , CASE } |
| Enum for object definition type. More... | |
Detailed Description
Interface for datasets for the DVS Reader API.
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()
|
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_rank buffer 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()
|
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()
|
pure virtual |
Get the number of parts for this dataset.
- Returns
- uint32_t the number of parts
◆ get_num_plots()
|
pure virtual |
Get the number of plots for this datasets.
- Returns
- uint32_t the number of plots for this dataset
◆ get_num_ranks()
|
pure virtual |
Get the number of ranks for the dataset.
- Returns
- uint32_t number of ranks
◆ get_num_variables()
|
pure virtual |
Get the number of variables for this dataset.
- Returns
- uint32_t the number of variable definitions
◆ get_part()
|
pure virtual |
Get a part by index.
- Parameters
-
index index of the part
- Returns
- DVS::IObject* pointer to part object or nullptr if not found
◆ get_plot()
|
pure virtual |
Get the plot object.
- Parameters
-
index the index of the plot to retrieve
- Returns
- DVS::IObject* pointer to DVS::IObject plot or nullptr
◆ get_ranks()
|
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] ranks buffer 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()
|
pure virtual |
Get the unit system of the dataset.
- Returns
- const char* unit system of the dataset
◆ get_var()
|
pure virtual |
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_dataset_interface.h