DiCE API nvidia_logo_transpbg.gif Up
mi::ISpectrum Class Referenceabstract

This interface represents spectrums. More...

#include <ispectrum.h>

Inheritance diagram for mi::ISpectrum:

Public Member Functions

virtual Spectrum_struct get_value () const =0
 Returns the spectrum represented by this interface. More...
 
virtual void get_value (Spectrum_struct &value) const =0
 Returns the spectrum represented by this interface. More...
 
virtual void set_value (const Spectrum_struct &value)=0
 Sets the spectrum represented by this interface. More...
 
virtual bool get_value (Size row, Size column, bool &value) const=0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Sint32 &value) const=0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Uint32 &value) const=0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Float32 &value) const=0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Float64 &value) const=0
 Accesses the (row, column)-th element. More...
 
template<class T>
get_value (Size row, Size column) const
 Accesses the (row, column)-th element. More...
 
virtual const base::IInterfaceget_value (const char *key) const =0
 Returns the value for key key. More...
 
template<class T>
const T * get_value (const char *key) const
 Returns the value for key key. More...
 
virtual base::IInterfaceget_value (const char *key)=0
 Returns the value for key key. More...
 
template<class T>
T * get_value (const char *key)
 Returns the value for key key. More...
 
virtual const base::IInterfaceget_value (Size index) const =0
 Returns the value for index index. More...
 
template<class T>
const T * get_value (Size index) const
 Returns the value for index index. More...
 
virtual base::IInterfaceget_value (Size index)=0
 Returns the value for index index. More...
 
template<class T>
T * get_value (Size index)
 Returns the value for index index. More...
 
virtual bool set_value (Size row, Size column, bool value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Sint32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Uint32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Float32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Float64 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual Sint32 set_value (const char *key, base::IInterface *value)=0
 Stores the value for key key. More...
 
virtual Sint32 set_value (Size index, base::IInterface *value)=0
 Stores the value for index index. More...
 
- Public Member Functions inherited from mi::ICompound
virtual Size get_number_of_rows () const =0
 Returns the number of rows of the represented matrix or vector. More...
 
virtual Size get_number_of_columns () const =0
 Returns the number of columns of the represented matrix. More...
 
virtual Size get_length () const =0
 Returns the total number of elements. More...
 
virtual const char * get_element_type_name () const =0
 Returns the type name of elements of the compound. More...
 
virtual bool get_value (Size row, Size column, bool &value) const =0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Sint32 &value) const =0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Uint32 &value) const =0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Float32 &value) const =0
 Accesses the (row, column)-th element. More...
 
virtual bool get_value (Size row, Size column, Float64 &value) const =0
 Accesses the (row, column)-th element. More...
 
template<class T>
get_value (Size row, Size column) const
 Accesses the (row, column)-th element. More...
 
virtual bool set_value (Size row, Size column, bool value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Sint32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Uint32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Float32 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual bool set_value (Size row, Size column, Float64 value)=0
 Sets the (row, column)-th element to value. More...
 
virtual void get_values (bool *values) const =0
 Accesses the elements of the compound. More...
 
virtual void get_values (Sint32 *values) const =0
 Accesses the elements of the compound. More...
 
virtual void get_values (Uint32 *values) const =0
 Accesses the elements of the compound. More...
 
virtual void get_values (Float32 *values) const =0
 Accesses the elements of the compound. More...
 
virtual void get_values (Float64 *values) const =0
 Accesses the elements of the compound. More...
 
virtual void set_values (const bool *values)=0
 Sets the elements of the compound. More...
 
virtual void set_values (const Sint32 *values)=0
 Sets the elements of the compound. More...
 
virtual void set_values (const Uint32 *values)=0
 Sets the elements of the compound. More...
 
virtual void set_values (const Float32 *values)=0
 Sets the elements of the compound. More...
 
virtual void set_values (const Float64 *values)=0
 Sets the elements of the compound. More...
 
virtual const base::IInterfaceget_value (const char *key) const=0
 Returns the value for key key. More...
 
template<class T>
const T * get_value (const char *key) const
 Returns the value for key key. More...
 
virtual base::IInterfaceget_value (const char *key)=0
 Returns the value for key key. More...
 
template<class T>
T * get_value (const char *key)
 Returns the value for key key. More...
 
virtual const base::IInterfaceget_value (Size index) const=0
 Returns the value for index index. More...
 
template<class T>
const T * get_value (Size index) const
 Returns the value for index index. More...
 
virtual base::IInterfaceget_value (Size index)=0
 Returns the value for index index. More...
 
template<class T>
T * get_value (Size index)
 Returns the value for index index. More...
 
virtual Sint32 set_value (const char *key, base::IInterface *value)=0
 Stores the value for key key. More...
 
virtual Sint32 set_value (Size index, base::IInterface *value)=0
 Stores the value for index index. More...
 
- Public Member Functions inherited from mi::IData_collection
virtual Size get_length () const =0
 Returns the number of values. More...
 
virtual const char * get_key (Size index) const =0
 Returns the key corresponding to index. More...
 
virtual bool has_key (const char *key) const =0
 Indicates whether the key key exists or not. More...
 
virtual const base::IInterfaceget_value (const char *key) const =0
 Returns the value for key key. More...
 
template<class T>
const T * get_value (const char *key) const
 Returns the value for key key. More...
 
virtual base::IInterfaceget_value (const char *key)=0
 Returns the value for key key. More...
 
template<class T>
T * get_value (const char *key)
 Returns the value for key key. More...
 
virtual const base::IInterfaceget_value (Size index) const =0
 Returns the value for index index. More...
 
template<class T>
const T * get_value (Size index) const
 Returns the value for index index. More...
 
virtual base::IInterfaceget_value (Size index)=0
 Returns the value for index index. More...
 
template<class T>
T * get_value (Size index)
 Returns the value for index index. More...
 
virtual Sint32 set_value (const char *key, base::IInterface *value)=0
 Stores the value for key key. More...
 
virtual Sint32 set_value (Size index, base::IInterface *value)=0
 Stores the value for index index. More...
 
- Public Member Functions inherited from mi::IData
virtual const char * get_type_name () const =0
 Returns the type name. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x127293dc, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::Interface_declare< 0x65437cd6, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::Interface_declare< 0x1bb2be0f, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::Interface_declare< 0x2e5f84bc, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x127293dc, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x65437cd6, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x1bb2be0f, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x2e5f84bc, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

This interface represents spectrums.

It can be used to represent spectrums by an interface derived from mi::base::IInterface.

See also
mi::Spectrum_struct

Member Function Documentation

 get_value() [1/16]

virtual Spectrum_struct mi::ISpectrum::get_value ( ) const
pure virtual

Returns the spectrum represented by this interface.

 get_value() [2/16]

template<class T>
T * mi::IData_collection::get_value ( const char *  key)
inlinevirtual

Returns the value for key key.

Note
If a literal 0 is passed for key, the call is ambiguous. You need to explicitly cast the argument to const char*.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Template Parameters
TThe interface type of the element to return.

Reimplemented from mi::ICompound.

 get_value() [3/16]

template<class T>
const T * mi::IData_collection::get_value ( const char *  key) const
inlinevirtual

Returns the value for key key.

Note
If a literal 0 is passed for key, the call is ambiguous. You need to explicitly cast the argument to const char*.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Template Parameters
TThe interface type of the element to return.

Reimplemented from mi::ICompound.

 get_value() [4/16]

virtual const base::IInterface * mi::IData_collection::get_value ( const char *  key) const
virtual

Returns the value for key key.

Note
If a literal 0 is passed for key, the call is ambiguous. You need to explicitly cast the argument to const char*.

Reimplemented from mi::ICompound.

 get_value() [5/16]

virtual base::IInterface * mi::IData_collection::get_value ( const char *  key)
virtual

Returns the value for key key.

Note
If a literal 0 is passed for key, the call is ambiguous. You need to explicitly cast the argument to const char*.

Reimplemented from mi::ICompound.

 get_value() [6/16]

template<class T>
T * mi::IData_collection::get_value ( Size  index)
inlinevirtual

Returns the value for index index.

Note
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the argument to mi::Size.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Template Parameters
TThe interface type of the element to return.

Reimplemented from mi::ICompound.

 get_value() [7/16]

template<class T>
const T * mi::IData_collection::get_value ( Size  index) const
inlinevirtual

Returns the value for index index.

Note
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the argument to mi::Size.

This templated member function is a wrapper of the non-template variant for the user's convenience. It eliminates the need to call mi::base::IInterface::get_interface(const Uuid&) on the returned pointer, since the return type already is a pointer to the type T specified as template parameter.

Template Parameters
TThe interface type of the element to return.

Reimplemented from mi::ICompound.

 get_value() [8/16]

virtual const base::IInterface * mi::IData_collection::get_value ( Size  index) const
virtual

Returns the value for index index.

Note
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the argument to mi::Size.

Reimplemented from mi::ICompound.

 get_value() [9/16]

virtual base::IInterface * mi::IData_collection::get_value ( Size  index)
virtual

Returns the value for index index.

Note
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the argument to mi::Size.

Reimplemented from mi::ICompound.

 get_value() [10/16]

template<class T>
T mi::ICompound::get_value ( Size  row,
Size  column 
) const
inline

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

 get_value() [11/16]

virtual bool mi::ICompound::get_value ( Size  row,
Size  column,
bool &  value 
) const
virtual

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 get_value() [12/16]

virtual bool mi::ICompound::get_value ( Size  row,
Size  column,
Float32 value 
) const
virtual

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 get_value() [13/16]

virtual bool mi::ICompound::get_value ( Size  row,
Size  column,
Float64 value 
) const
virtual

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 get_value() [14/16]

virtual bool mi::ICompound::get_value ( Size  row,
Size  column,
Sint32 value 
) const
virtual

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 get_value() [15/16]

virtual bool mi::ICompound::get_value ( Size  row,
Size  column,
Uint32 value 
) const
virtual

Accesses the (row, column)-th element.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 get_value() [16/16]

virtual void mi::ISpectrum::get_value ( Spectrum_struct value) const
pure virtual

Returns the spectrum represented by this interface.

 set_value() [1/8]

virtual Sint32 mi::IData_collection::set_value ( const char *  key,
base::IInterface value 
)
virtual

Stores the value for key key.

Note that it is not possible to create new keys.

Note
If a literal 0 is passed for key, the call is ambiguous. You need to explicitly cast the argument to const char*.
Returns
  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: Invalid key.
  • -3: value has the wrong type.

Reimplemented from mi::ICompound.

 set_value() [2/8]

virtual void mi::ISpectrum::set_value ( const Spectrum_struct value)
pure virtual

Sets the spectrum represented by this interface.

 set_value() [3/8]

virtual Sint32 mi::IData_collection::set_value ( Size  index,
base::IInterface value 
)
virtual

Stores the value for index index.

Note that it is not possible to create new indices.

Note
If a literal 0 is passed for index, the call is ambiguous. You need to explicitly cast the argument to mi::Size.
Returns
  • 0: Success.
  • -1: Invalid parameters (NULL pointer).
  • -2: Invalid index.
  • -3: value has the wrong type.

Reimplemented from mi::ICompound.

 set_value() [4/8]

virtual bool mi::ICompound::set_value ( Size  row,
Size  column,
bool  value 
)
virtual

Sets the (row, column)-th element to value.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 set_value() [5/8]

virtual bool mi::ICompound::set_value ( Size  row,
Size  column,
Float32  value 
)
virtual

Sets the (row, column)-th element to value.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 set_value() [6/8]

virtual bool mi::ICompound::set_value ( Size  row,
Size  column,
Float64  value 
)
virtual

Sets the (row, column)-th element to value.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 set_value() [7/8]

virtual bool mi::ICompound::set_value ( Size  row,
Size  column,
Sint32  value 
)
virtual

Sets the (row, column)-th element to value.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.

 set_value() [8/8]

virtual bool mi::ICompound::set_value ( Size  row,
Size  column,
Uint32  value 
)
virtual

Sets the (row, column)-th element to value.

Precondition
row < get_number_of_rows(), column < get_number_of_columns()

Implements mi::ICompound.