NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::INumber Class Referenceabstract

This interface represents simple numeric types. More...

Inheritance diagram for mi::INumber:
Inheritance graph
[legend]

Public Member Functions

virtual void  get_value (bool &val) const =0
  Returns the value of the object as bool. More...
 
virtual void  set_value (bool val)=0
  Sets the value of the object via a parameter of type bool. More...
 
virtual void  get_value (Uint8 &val) const =0
  Returns the value of the object as mi::Uint8. More...
 
virtual void  set_value (Uint8 val)=0
  Sets the value of the object via a parameter of type mi::Uint8. More...
 
virtual void  get_value (Uint16 &val) const =0
  Returns the value of the object as mi::Uint16. More...
 
virtual void  set_value (Uint16 val)=0
  Sets the value of the object via a parameter of type mi::Uint16. More...
 
virtual void  get_value (Uint32 &val) const =0
  Returns the value of the object as mi::Uint32. More...
 
virtual void  set_value (Uint32 val)=0
  Sets the value of the object via a parameter of type mi::Uint32. More...
 
virtual void  get_value (Uint64 &val) const =0
  Returns the value of the object as mi::Uint64. More...
 
virtual void  set_value (Uint64 val)=0
  Sets the value of the object via a parameter of type mi::Uint64. More...
 
virtual void  get_value (Sint8 &val) const =0
  Returns the value of the object as mi::Sint8. More...
 
virtual void  set_value (Sint8 val)=0
  Sets the value of the object via a parameter of type mi::Sint8. More...
 
virtual void  get_value (Sint16 &val) const =0
  Returns the value of the object as mi::Sint16. More...
 
virtual void  set_value (Sint16 val)=0
  Sets the value of the object via a parameter of type mi::Sint16. More...
 
virtual void  get_value (Sint32 &val) const =0
  Returns the value of the object as mi::Sint32. More...
 
virtual void  set_value (Sint32 val)=0
  Sets the value of the object via a parameter of type mi::Sint32. More...
 
virtual void  get_value (Sint64 &val) const =0
  Returns the value of the object as mi::Sint64. More...
 
virtual void  set_value (Sint64 val)=0
  Sets the value of the object via a parameter of type mi::Sint64. More...
 
virtual void  get_value (Float32 &val) const =0
  Returns the value of the object as mi::Float32. More...
 
virtual void  set_value (Float32 val)=0
  Sets the value of the object via a parameter of type mi::Float32. More...
 
virtual void  get_value (Float64 &val) const =0
  Returns the value of the object as mi::Float64. More...
 
virtual void  set_value (Float64 val)=0
  Sets the value of the object via a parameter of type mi::Float64. More...
 
template<class T >
get_value () const
  Returns the value of the object. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x07366a82, 0x3d0c, 0x46e9, 0x88, 0x0e, 0xed, 0x65, 0xba, 0xde, 0xef, 0x2b, IData_simple >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IData_simple
Self
  Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
  Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x07366a82, 0x3d0c, 0x46e9, 0x88, 0x0e, 0xed, 0x65, 0xba, 0xde, 0xef, 0x2b, IData_simple >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

This interface represents simple numeric types.

The methods get_value() and set_value() are overloaded for the various numeric types. If necessary a conversion as defined by the C/C++ standard is performed.

Member Function Documentation

virtual void mi::INumber::get_value ( bool &  val) const
pure virtual

Returns the value of the object as bool.

virtual void mi::INumber::get_value ( Uint8 val) const
pure virtual

Returns the value of the object as mi::Uint8.

virtual void mi::INumber::get_value ( Uint16 val) const
pure virtual

Returns the value of the object as mi::Uint16.

virtual void mi::INumber::get_value ( Uint32 val) const
pure virtual

Returns the value of the object as mi::Uint32.

virtual void mi::INumber::get_value ( Uint64 val) const
pure virtual

Returns the value of the object as mi::Uint64.

virtual void mi::INumber::get_value ( Sint8 val) const
pure virtual

Returns the value of the object as mi::Sint8.

virtual void mi::INumber::get_value ( Sint16 val) const
pure virtual

Returns the value of the object as mi::Sint16.

virtual void mi::INumber::get_value ( Sint32 val) const
pure virtual

Returns the value of the object as mi::Sint32.

virtual void mi::INumber::get_value ( Sint64 val) const
pure virtual

Returns the value of the object as mi::Sint64.

virtual void mi::INumber::get_value ( Float32 val) const
pure virtual

Returns the value of the object as mi::Float32.

virtual void mi::INumber::get_value ( Float64 val) const
pure virtual

Returns the value of the object as mi::Float64.

template<class T >
T mi::INumber::get_value ( ) const
inline

Returns the value of the object.

The type of the object represented by the interface is indicated by the template parameter.

This templated member function is a wrapper of the other functions of the same name for the user's convenience. It allows you to write

mi::Uint32 x = ivalue->get_value<mi::Uint32>();

instead of

ivalue->get_value( x)
virtual void mi::INumber::set_value ( bool  val)
pure virtual

Sets the value of the object via a parameter of type bool.

virtual void mi::INumber::set_value ( Uint8  val)
pure virtual

Sets the value of the object via a parameter of type mi::Uint8.

virtual void mi::INumber::set_value ( Uint16  val)
pure virtual

Sets the value of the object via a parameter of type mi::Uint16.

virtual void mi::INumber::set_value ( Uint32  val)
pure virtual

Sets the value of the object via a parameter of type mi::Uint32.

virtual void mi::INumber::set_value ( Uint64  val)
pure virtual

Sets the value of the object via a parameter of type mi::Uint64.

virtual void mi::INumber::set_value ( Sint8  val)
pure virtual

Sets the value of the object via a parameter of type mi::Sint8.

virtual void mi::INumber::set_value ( Sint16  val)
pure virtual

Sets the value of the object via a parameter of type mi::Sint16.

virtual void mi::INumber::set_value ( Sint32  val)
pure virtual

Sets the value of the object via a parameter of type mi::Sint32.

virtual void mi::INumber::set_value ( Sint64  val)
pure virtual

Sets the value of the object via a parameter of type mi::Sint64.

virtual void mi::INumber::set_value ( Float32  val)
pure virtual

Sets the value of the object via a parameter of type mi::Float32.

virtual void mi::INumber::set_value ( Float64  val)
pure virtual

Sets the value of the object via a parameter of type mi::Float64.