## On this page

  

 

 # DVS::IObject Class Reference

 Last update: 16.07.2025 

`#include <<a class="el" href="dvs__object__interface_8h_source.xhtml">dvs_object_interface.h</a>>`

Inheritance diagram for DVS::IObject:

 ![](/sites/default/files/migrate-content/post_processing_tools_2024_r1/class_d_v_s_1_1_i_object.png)



## <a id="pub-types" name="pub-types"></a>Public Types

enum [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) { [PART](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6), [PLOT](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae), [CASE](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd) } ## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="ac8a6734ee192a26b574e9eec520c1495" name="ac8a6734ee192a26b574e9eec520c1495"></a> **IObject** ()=default <a id="a26912f7959e8f0e610074833c677a904" name="a26912f7959e8f0e610074833c677a904"></a>virtual **~IObject** ()=default <a id="aae99076e42a6fc37bf9a71303b3db2b5" name="aae99076e42a6fc37bf9a71303b3db2b5"></a> **IObject** ([IObject](class_d_v_s_1_1_i_object.xhtml) &amp;&amp;)=default <a id="ae90f3c11b1fdf916b59490005b148fd5" name="ae90f3c11b1fdf916b59490005b148fd5"></a>[IObject](class_d_v_s_1_1_i_object.xhtml) &amp; **operator=** ([IObject](class_d_v_s_1_1_i_object.xhtml) &amp;&amp;)=default <a id="af147aaab5200462fd620dbdd4a39ac76" name="af147aaab5200462fd620dbdd4a39ac76"></a> **IObject** (const [IObject](class_d_v_s_1_1_i_object.xhtml) &amp;)=default <a id="a9953812222e436976af29d1f84967f85" name="a9953812222e436976af29d1f84967f85"></a>[IObject](class_d_v_s_1_1_i_object.xhtml) &amp; **operator=** (const [IObject](class_d_v_s_1_1_i_object.xhtml) &amp;)=default virtual const char \* [get\_name](class_d_v_s_1_1_i_object.xhtml#a39be8b08200f75b20a7b5cf715ba9dd3) () const =0 virtual [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) [get\_type](class_d_v_s_1_1_i_object.xhtml#a889c46624013cc3802c7164d153b95f6) () const =0 virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml) \* [get\_dataset](class_d_v_s_1_1_i_object.xhtml#aea688a307b1cb02ae53e0e8fd3791e64) () const =0 virtual uint32\_t [get\_num\_metadata](class_d_v_s_1_1_i_object.xhtml#a31db3b716cc815c2c73f826f24384f6a) () const =0 virtual const char \* [get\_metadata\_key](class_d_v_s_1_1_i_object.xhtml#a04ee2919ffeb46d966d4675c8cd4420c) (uint32\_t index) const =0 virtual const char \* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#a7a37d603ccf93f7f1ec9f962fa9d1f61) (uint32\_t index) const =0 virtual const char \* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#aa33105e0510c3a2b0da022d5e9632bc8) (const char \*key) const =0 <a id="details" name="details"></a>## 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](dvs__query__interface_8h.xhtml "DVS Reader API Query Interface.") for more information.

Definition at line [44](dvs__object__interface_8h_source.xhtml#l00044) of file [dvs\_object\_interface.h](dvs__object__interface_8h_source.xhtml).



## Member Enumeration Documentation

<a id="aa897daa1f7d0467515fd108c29015348" name="aa897daa1f7d0467515fd108c29015348"></a>## [◆ ](#aa897daa1f7d0467515fd108c29015348)ObjectDefType

 enum [DVS::IObject::ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348)

Enum for object definition type.

Enumerator<a id="aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6" name="aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6"></a>PART Type for a part object.

<a id="aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae" name="aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae"></a>PLOT Type for a plot object.

<a id="aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd" name="aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd"></a>CASE Type for a case object, used for case/dataset wide variables.

Definition at line [59](dvs__object__interface_8h_source.xhtml#l00059) of file [dvs\_object\_interface.h](dvs__object__interface_8h_source.xhtml).





## Member Function Documentation

<a id="aea688a307b1cb02ae53e0e8fd3791e64" name="aea688a307b1cb02ae53e0e8fd3791e64"></a>## [◆ ](#aea688a307b1cb02ae53e0e8fd3791e64)get\_dataset()

 virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml) \* DVS::IObject::get\_dataset  ( )  const  pure virtual 

Get the reference dataset for this object.

Returnsconst [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml "Interface for datasets for the DVS Reader API.")\* reference to the dataset 



<a id="a04ee2919ffeb46d966d4675c8cd4420c" name="a04ee2919ffeb46d966d4675c8cd4420c"></a>## [◆ ](#a04ee2919ffeb46d966d4675c8cd4420c)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 Returnsconst char\* key of the metadata, nullptr if not found 



<a id="aa33105e0510c3a2b0da022d5e9632bc8" name="aa33105e0510c3a2b0da022d5e9632bc8"></a>## [◆ ](#aa33105e0510c3a2b0da022d5e9632bc8)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 Returnsconst char\* value of the metadata, nullptr if not found 



<a id="a7a37d603ccf93f7f1ec9f962fa9d1f61" name="a7a37d603ccf93f7f1ec9f962fa9d1f61"></a>## [◆ ](#a7a37d603ccf93f7f1ec9f962fa9d1f61)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 Returnsconst char\* value of the metadata, nullptr if not found 



<a id="a39be8b08200f75b20a7b5cf715ba9dd3" name="a39be8b08200f75b20a7b5cf715ba9dd3"></a>## [◆ ](#a39be8b08200f75b20a7b5cf715ba9dd3)get\_name()

 virtual const char \* DVS::IObject::get\_name  ( )  const  pure virtual 

Get the name of the object.

Returnsconst char\* name of the object 



<a id="a31db3b716cc815c2c73f826f24384f6a" name="a31db3b716cc815c2c73f826f24384f6a"></a>## [◆ ](#a31db3b716cc815c2c73f826f24384f6a)get\_num\_metadata()

 virtual uint32\_t DVS::IObject::get\_num\_metadata  ( )  const  pure virtual 

Get the number of metadata objects.

Returnsuint32\_t number of metadata objects 



<a id="a889c46624013cc3802c7164d153b95f6" name="a889c46624013cc3802c7164d153b95f6"></a>## [◆ ](#a889c46624013cc3802c7164d153b95f6)get\_type()

 virtual [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) DVS::IObject::get\_type  ( )  const  pure virtual 

Get the type of the object.

ReturnsObjectDefType 



---

The documentation for this class was generated from the following file:- D:/Product-src/ensight/user\_defined\_src/readers/dvs/include/[dvs\_object\_interface.h](dvs__object__interface_8h_source.xhtml)