DVS::IVar Class Reference
Last update: 17.04.2023Interface for variables for the DVS Reader API. More...
#include <dvs_var_interface.h>
Public Member Functions | |
| IVar ()=default | |
| default | |
| virtual | ~IVar ()=default |
| default | |
| IVar (IVar &&)=default | |
| default | |
| IVar & | operator= (IVar &&)=default |
| default | |
| IVar (const IVar &)=default | |
| support copying | |
| IVar & | operator= (const IVar &)=default |
| default | |
| virtual const char * | get_name () const =0 |
| Get the name of the variable. More... | |
| virtual dvs_var_type | get_var_type () const =0 |
| Get the type of var. More... | |
| virtual dvs_var_location | get_var_location () const =0 |
| Get the var location. More... | |
| virtual uint32_t | get_float_count_per_value () const =0 |
| Get the number of floats per value. More... | |
| virtual const char * | get_unit_dimension () const =0 |
| Get the unit dimensions as string. More... | |
| virtual const char * | get_unit_label () const =0 |
| Get the unit label as string. More... | |
| virtual const DVS::IDataset * | get_dataset () const =0 |
| Get the reference dataset for this var. More... | |
| virtual uint32_t | get_num_metadata () const =0 |
| Get the num metadata values on this var. More... | |
| virtual const char * | get_metadata_key (uint32_t index) const =0 |
| Get a metadata key based on the index. More... | |
| virtual const char * | get_metadata_value (uint32_t index) const =0 |
| Get the metadata value base on the index. More... | |
| virtual const char * | get_metadata_value (const char *key) const =0 |
| Get the metadata value based on the key. More... | |
Detailed Description
Interface for variables 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 44 of file dvs_var_interface.h.
Member Function Documentation
◆ get_dataset()
|
pure virtual |
Get the reference dataset for this var.
- Returns
- const DVS::IDataset* the reference to the dataset
◆ get_float_count_per_value()
|
pure virtual |
Get the number of floats per value.
Gets the size of each value, i.e. a scalar is 1 a vector is 3 etc.
- Returns
- uint32_t size of each value for the var
◆ get_metadata_key()
|
pure virtual |
Get a metadata key based on the index.
- Parameters
-
index index of the key to return
- Returns
- const char* key for the metadata, nullptr if not found
◆ get_metadata_value() [1/2]
|
pure virtual |
Get the metadata value based on the key.
- Parameters
-
key the key to return the value of
- Returns
- const char* value for the key, nullptr if not found
◆ get_metadata_value() [2/2]
|
pure virtual |
Get the metadata value base on the index.
- Parameters
-
index index of the value to return
- Returns
- const char* value for the metadata, nullptr if not found
◆ get_name()
|
pure virtual |
Get the name of the variable.
- Returns
- const char* name of variable
◆ get_num_metadata()
|
pure virtual |
Get the num metadata values on this var.
- Returns
- uint32_t number of metadata keys/values
◆ get_unit_dimension()
|
pure virtual |
Get the unit dimensions as string.
- Returns
- const char* string of unit dimensions
◆ get_unit_label()
|
pure virtual |
Get the unit label as string.
This is a specialized name referring to the dimensions
- Returns
- const char* string of unit label
◆ get_var_location()
|
pure virtual |
Get the var location.
- Returns
- dvs_var_location location of var
◆ get_var_type()
|
pure virtual |
Get the type of var.
- Returns
- dvs_var_type type of var
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_var_interface.h