Post-processing tools 2023 R2

DVS::IObject Class Reference

Last update: 17.04.2023

Interface for part/plot objects for DVS Reader API. More...

#include <dvs_object_interface.h>

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

Public Types

enum  ObjectDefType { PART , PLOT , CASE }
 Enum for object definition type. More...
 

Public Member Functions

 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...
 

Detailed Description

Interface for part/plot objects for 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_object_interface.h.

Member Enumeration Documentation

◆ ObjectDefType

enum DVS::IObject::ObjectDefType

Enum for object definition type.

Enumerator
PART 

Type for a part object.

PLOT 

Type for a plot object.

CASE 

Type for a case object, used for case/dataset wide variables.

Definition at line 59 of file dvs_object_interface.h.

Member Function Documentation

◆ get_dataset()

virtual const DVS::IDataset* DVS::IObject::get_dataset ( ) const
pure virtual

Get the reference dataset for this object.

Returns
const DVS::IDataset* reference to the dataset

◆ get_metadata_key()

virtual const char* DVS::IObject::get_metadata_key ( uint32_t  index) const
pure virtual

Get the metadata key by index.

Parameters
indexindex of the metadata to get the key for
Returns
const char* key of the metadata, nullptr if not found

◆ get_metadata_value() [1/2]

virtual const char* DVS::IObject::get_metadata_value ( const char *  key) const
pure virtual

Get the metadata value object.

Parameters
keykey to get the value for
Returns
const char* value of the metadata, nullptr if not found

◆ get_metadata_value() [2/2]

virtual const char* DVS::IObject::get_metadata_value ( uint32_t  index) const
pure virtual

Get the metadata value by index.

Parameters
indexindex of the metadata to get the value for
Returns
const char* value of the metadata, nullptr if not found

◆ get_name()

virtual const char* DVS::IObject::get_name ( ) const
pure virtual

Get the name of the object.

Returns
const char* name of the object

◆ get_num_metadata()

virtual uint32_t DVS::IObject::get_num_metadata ( ) const
pure virtual

Get the number of metadata objects.

Returns
uint32_t number of metadata objects

◆ get_type()

virtual ObjectDefType DVS::IObject::get_type ( ) const
pure virtual

Get the type of the object.

Returns
ObjectDefType
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_object_interface.h

Connect with Ansys