Iray SDK API nvidia_logo_transpbg.gif Up
idictionary.h
Go to the documentation of this file.
1/***************************************************************************************************
2 * Copyright 2024 NVIDIA Corporation. All rights reserved.
3 **************************************************************************************************/
6
7#ifndef MI_NEURAYLIB_IDICTIONARY_H
8#define MI_NEURAYLIB_IDICTIONARY_H
9
11
12namespace mi {
13
14namespace neuraylib {
15
41 public base::Interface_declare<0xea00ed83,0x210e,0x4d65,0xa9,0x8d,0xfe,0xfa,0xb6,0xeb,0x03,0x2c>
42{
43public:
52 virtual bool set( const char* key, bool value) = 0;
53
62 virtual bool set( const char* key, const char* value) = 0;
63
72 virtual bool set( const char* key, Uint32 value) = 0;
73
82 virtual bool set( const char* key, Sint32 value) = 0;
83
93 virtual bool set( const char* key, Float32 value) = 0;
94
103 virtual bool set( const char* key, Float64 value) = 0;
104
106 virtual bool is_defined( const char* key) const = 0;
107
111 virtual const char* get( const char* key, const char* default_value) const = 0;
112
116 virtual bool get( const char* key, bool default_value) const = 0;
117
121 virtual Sint32 get( const char* key, Sint32 default_value) const = 0;
122
126 virtual Uint32 get( const char* key, Uint32 default_value) const = 0;
127
131 virtual Float32 get( const char* key, Float32 default_value) const = 0;
132
136 virtual Float64 get( const char* key, Float64 default_value) const = 0;
137
141 virtual bool is_invalid() const = 0;
142};
143 // end group mi_neuray_functors
145
146} // namespace neuraylib
147
148} // namespace mi
149
150#endif // MI_NEURAYLIB_IDICTIONARY_H
Mixin class template for deriving new interface declarations.
Definition: interface_declare.h:43
The dictionary is a data structure that stores a mapping from a fixed set of keys to a their modifiab...
Definition: idictionary.h:42
virtual bool set(const char *key, Float32 value)=0
Sets the value of the given key to the given value.
virtual Float32 get(const char *key, Float32 default_value) const =0
Returns the value for the given key.
virtual bool set(const char *key, Float64 value)=0
Sets the value of the given key to the given value.
virtual bool set(const char *key, Uint32 value)=0
Sets the value of the given key to the given value.
virtual const char * get(const char *key, const char *default_value) const =0
Returns the value for the given key.
virtual bool set(const char *key, bool value)=0
Sets the value of the given key to the given value.
virtual bool get(const char *key, bool default_value) const =0
Returns the value for the given key.
virtual Uint32 get(const char *key, Uint32 default_value) const =0
Returns the value for the given key.
virtual Float64 get(const char *key, Float64 default_value) const =0
Returns the value for the given key.
virtual bool set(const char *key, Sint32 value)=0
Sets the value of the given key to the given value.
virtual bool is_invalid() const =0
Returns the invalidity flag of the dictionary.
virtual bool is_defined(const char *key) const =0
Returns true if and only if the given key exists.
virtual bool set(const char *key, const char *value)=0
Sets the value of the given key to the given value.
virtual Sint32 get(const char *key, Sint32 default_value) const =0
Returns the value for the given key.
unsigned int Uint32
32-bit unsigned integer.
Definition: types.h:49
double Float64
64-bit float.
Definition: types.h:52
float Float32
32-bit float.
Definition: types.h:51
signed int Sint32
32-bit signed integer.
Definition: types.h:46
Mixin class template for deriving new interface declarations.
Common namespace for APIs of NVIDIA Advanced Rendering Center GmbH.
Definition: neuraylib.h:179