## On this page

  

 

 # dvs\_object\_interface

 Last update: 16.07.2025 

[Go to the documentation of this file.](dvs__object__interface_8h.xhtml)<a id="l00001" name="l00001"></a> 1 /\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00002" name="l00002"></a> 2 \*

<a id="l00003" name="l00003"></a> 3 \* (C) 2022 ANSYS, Inc. Unauthorized use, distribution, or duplication is prohibited.

<a id="l00004" name="l00004"></a> 4 \*

<a id="l00005" name="l00005"></a> 5 \* Restricted Rights Legend

<a id="l00006" name="l00006"></a> 6 \*

<a id="l00007" name="l00007"></a> 7 \* Use, duplication, or disclosure of this

<a id="l00008" name="l00008"></a> 8 \* software and its documentation by the

<a id="l00009" name="l00009"></a> 9 \* Government is subject to restrictions as

<a id="l00010" name="l00010"></a> 10 \* set forth in subdivision \[(b)(3)(ii)\] of

<a id="l00011" name="l00011"></a> 11 \* the Rights in Technical Data and Computer

<a id="l00012" name="l00012"></a> 12 \* Software clause at 52.227-7013.

<a id="l00013" name="l00013"></a> 13 \*

<a id="l00014" name="l00014"></a> 14 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*

<a id="l00015" name="l00015"></a> 15 \*/

<a id="l00016" name="l00016"></a> 16 

<a id="l00024" name="l00024"></a> 24 \#ifndef \_\_\_DVS\_OBJECT\_INTERFACE\_H\_\_\_

<a id="l00025" name="l00025"></a> 25 \#define \_\_\_DVS\_OBJECT\_INTERFACE\_H\_\_\_

<a id="l00026" name="l00026"></a> 26 

<a id="l00027" name="l00027"></a> 27 \#include "[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)"

<a id="l00028" name="l00028"></a> 28 \#include "[dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml)"

<a id="l00029" name="l00029"></a> 29 

<a id="l00030" name="l00030"></a> 30 namespace DVS

<a id="l00031" name="l00031"></a> 31 {

<a id="l00032" name="l00032"></a> 32 

<a id="l00033" name="l00033"></a> 33 class IDataset;

<a id="l00034" name="l00034"></a> 34 

<a id="l00044" name="l00044"></a>[ 44](class_d_v_s_1_1_i_object.xhtml) class [IObject](class_d_v_s_1_1_i_object.xhtml)

<a id="l00045" name="l00045"></a> 45 {

<a id="l00046" name="l00046"></a> 46 public:

<a id="l00047" name="l00047"></a> 47 

<a id="l00048" name="l00048"></a>[ 48](class_d_v_s_1_1_i_object.xhtml#ac8a6734ee192a26b574e9eec520c1495) [IObject](class_d_v_s_1_1_i_object.xhtml#ac8a6734ee192a26b574e9eec520c1495)() = default; 

<a id="l00049" name="l00049"></a>[ 49](class_d_v_s_1_1_i_object.xhtml#a26912f7959e8f0e610074833c677a904) virtual [~IObject](class_d_v_s_1_1_i_object.xhtml#a26912f7959e8f0e610074833c677a904)() = default; 

<a id="l00050" name="l00050"></a>[ 50](class_d_v_s_1_1_i_object.xhtml#aae99076e42a6fc37bf9a71303b3db2b5) [IObject](class_d_v_s_1_1_i_object.xhtml#aae99076e42a6fc37bf9a71303b3db2b5)([IObject](class_d_v_s_1_1_i_object.xhtml)&amp;&amp;) = default; 

<a id="l00051" name="l00051"></a>[ 51](class_d_v_s_1_1_i_object.xhtml#aaf7c15538ff1a9e0969f670e8a8beb6d) [IObject](class_d_v_s_1_1_i_object.xhtml)&amp; [operator=](class_d_v_s_1_1_i_object.xhtml#aaf7c15538ff1a9e0969f670e8a8beb6d)([IObject](class_d_v_s_1_1_i_object.xhtml)&amp;&amp;) = default; 

<a id="l00052" name="l00052"></a>[ 52](class_d_v_s_1_1_i_object.xhtml#af147aaab5200462fd620dbdd4a39ac76) [IObject](class_d_v_s_1_1_i_object.xhtml#af147aaab5200462fd620dbdd4a39ac76)(const [IObject](class_d_v_s_1_1_i_object.xhtml)&amp;) = default; 

<a id="l00053" name="l00053"></a>[ 53](class_d_v_s_1_1_i_object.xhtml#ae9617f7ddf7f5c4f31cb6d8bdec8d84a) [IObject](class_d_v_s_1_1_i_object.xhtml)&amp; [operator=](class_d_v_s_1_1_i_object.xhtml#ae9617f7ddf7f5c4f31cb6d8bdec8d84a)(const [IObject](class_d_v_s_1_1_i_object.xhtml)&amp;) = default; 

<a id="l00054" name="l00054"></a> 54 

<a id="l00059" name="l00059"></a>[ 59](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348) enum [ObjectDefType](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348)

<a id="l00060" name="l00060"></a> 60 {

<a id="l00061" name="l00061"></a>[ 61](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6) [PART](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6), 

<a id="l00062" name="l00062"></a>[ 62](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae) [PLOT](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae), 

<a id="l00063" name="l00063"></a> 63 [CASE](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd) 

<a id="l00064" name="l00064"></a>[ 64](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd) };

<a id="l00065" name="l00065"></a> 65 

<a id="l00071" name="l00071"></a>[ 71](class_d_v_s_1_1_i_object.xhtml#ae8edeb61ff2b87d3f3ea9cd6519e73d5) virtual const char* [get\_name](class_d_v_s_1_1_i_object.xhtml#ae8edeb61ff2b87d3f3ea9cd6519e73d5)() const = 0;

<a id="l00072" name="l00072"></a> 72 

<a id="l00078" name="l00078"></a>[ 78](class_d_v_s_1_1_i_object.xhtml#a889c46624013cc3802c7164d153b95f6) 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;

<a id="l00079" name="l00079"></a> 79 

<a id="l00085" name="l00085"></a>[ 85](class_d_v_s_1_1_i_object.xhtml#a9184ca61b90cf245c5f596f52756001b) virtual const [DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml)* [get\_dataset](class_d_v_s_1_1_i_object.xhtml#a9184ca61b90cf245c5f596f52756001b)() const = 0;

<a id="l00086" name="l00086"></a> 86 

<a id="l00092" name="l00092"></a>[ 92](class_d_v_s_1_1_i_object.xhtml#a31db3b716cc815c2c73f826f24384f6a) virtual uint32_t [get\_num\_metadata](class_d_v_s_1_1_i_object.xhtml#a31db3b716cc815c2c73f826f24384f6a)() const = 0;

<a id="l00093" name="l00093"></a> 93 

<a id="l00100" name="l00100"></a>[ 100](class_d_v_s_1_1_i_object.xhtml#a76a8b0bf7b55678cba9bcdb7e19c9a7f) virtual const char* [get\_metadata\_key](class_d_v_s_1_1_i_object.xhtml#a76a8b0bf7b55678cba9bcdb7e19c9a7f)(uint32_t index) const = 0;

<a id="l00101" name="l00101"></a> 101 

<a id="l00108" name="l00108"></a>[ 108](class_d_v_s_1_1_i_object.xhtml#aa391aa339c696ddb5fe582eb59bb7197) virtual const char* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#aa391aa339c696ddb5fe582eb59bb7197)(uint32_t index) const = 0;

<a id="l00109" name="l00109"></a> 109 

<a id="l00116" name="l00116"></a>[ 116](class_d_v_s_1_1_i_object.xhtml#a5ade463d34bba53bb9e66fa547a616bd) virtual const char* [get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#a5ade463d34bba53bb9e66fa547a616bd)(const char* key) const = 0;

<a id="l00117" name="l00117"></a> 117 };

<a id="l00118" name="l00118"></a> 118 

<a id="l00119" name="l00119"></a> 119 } //namespace DVS

<a id="l00120" name="l00120"></a> 120 

<a id="l00121" name="l00121"></a> 121 \#endif //\_\_\_DVS\_OBJECT\_INTERFACE\_H\_\_\_

[DVS::IDataset](class_d_v_s_1_1_i_dataset.xhtml)

Interface for datasets for the DVS Reader API.

**Definition:** [dvs\_dataset\_interface.h:44](dvs__dataset__interface_8h_source.xhtml#l00043)



[DVS::IObject](class_d_v_s_1_1_i_object.xhtml)

Interface for part/plot objects for DVS Reader API.

**Definition:** [dvs\_object\_interface.h:45](dvs__object__interface_8h_source.xhtml#l00044)



[DVS::IObject::~IObject](class_d_v_s_1_1_i_object.xhtml#a26912f7959e8f0e610074833c677a904)

virtual ~IObject()=default

default



[DVS::IObject::get\_num\_metadata](class_d_v_s_1_1_i_object.xhtml#a31db3b716cc815c2c73f826f24384f6a)

virtual uint32_t get_num_metadata() const =0

Get the number of metadata objects.



[DVS::IObject::get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#a5ade463d34bba53bb9e66fa547a616bd)

virtual const char * get_metadata_value(const char *key) const =0

Get the metadata value object.



[DVS::IObject::get\_metadata\_key](class_d_v_s_1_1_i_object.xhtml#a76a8b0bf7b55678cba9bcdb7e19c9a7f)

virtual const char * get_metadata_key(uint32_t index) const =0

Get the metadata key by index.



[DVS::IObject::get\_type](class_d_v_s_1_1_i_object.xhtml#a889c46624013cc3802c7164d153b95f6)

virtual ObjectDefType get_type() const =0

Get the type of the object.



[DVS::IObject::get\_dataset](class_d_v_s_1_1_i_object.xhtml#a9184ca61b90cf245c5f596f52756001b)

virtual const DVS::IDataset * get_dataset() const =0

Get the reference dataset for this object.



[DVS::IObject::get\_metadata\_value](class_d_v_s_1_1_i_object.xhtml#aa391aa339c696ddb5fe582eb59bb7197)

virtual const char * get_metadata_value(uint32_t index) const =0

Get the metadata value by index.



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

ObjectDefType

Enum for object definition type.

**Definition:** [dvs\_object\_interface.h:60](dvs__object__interface_8h_source.xhtml#l00059)



[DVS::IObject::CASE](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a03dcfd36d493cd1d828af236e2c357fd)

@ CASE

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

**Definition:** [dvs\_object\_interface.h:63](dvs__object__interface_8h_source.xhtml#l00064)



[DVS::IObject::PART](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348a8b2484e08a16329d2d91c18c254f5ca6)

@ PART

Type for a part object.

**Definition:** [dvs\_object\_interface.h:61](dvs__object__interface_8h_source.xhtml#l00061)



[DVS::IObject::PLOT](class_d_v_s_1_1_i_object.xhtml#aa897daa1f7d0467515fd108c29015348abe80fa1e67dae7efb56fdb2936914cae)

@ PLOT

Type for a plot object.

**Definition:** [dvs\_object\_interface.h:62](dvs__object__interface_8h_source.xhtml#l00062)



[DVS::IObject::IObject](class_d_v_s_1_1_i_object.xhtml#aae99076e42a6fc37bf9a71303b3db2b5)

IObject(IObject &amp;&amp;)=default

default



[DVS::IObject::operator=](class_d_v_s_1_1_i_object.xhtml#aaf7c15538ff1a9e0969f670e8a8beb6d)

IObject &amp; operator=(IObject &amp;&amp;)=default

default



[DVS::IObject::IObject](class_d_v_s_1_1_i_object.xhtml#ac8a6734ee192a26b574e9eec520c1495)

IObject()=default

default



[DVS::IObject::get\_name](class_d_v_s_1_1_i_object.xhtml#ae8edeb61ff2b87d3f3ea9cd6519e73d5)

virtual const char * get_name() const =0

Get the name of the object.



[DVS::IObject::operator=](class_d_v_s_1_1_i_object.xhtml#ae9617f7ddf7f5c4f31cb6d8bdec8d84a)

IObject &amp; operator=(const IObject &amp;)=default

default



[DVS::IObject::IObject](class_d_v_s_1_1_i_object.xhtml#af147aaab5200462fd620dbdd4a39ac76)

IObject(const IObject &amp;)=default

support copying



[dynamic\_visualization\_store\_enums.h](dynamic__visualization__store__enums_8h.xhtml)

Contains enums used in C/C++ API.



[dynamic\_visualization\_store\_error\_codes.h](dynamic__visualization__store__error__codes_8h.xhtml)

Contains errors used in the DVS C/C++ API.