DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib::ISerializable Class Referenceabstract

All serializable objects have to be derived from this interface. More...

#include <iserializer.h>

Inheritance diagram for mi::neuraylib::ISerializable:

Public Member Functions

virtual base::Uuid get_class_id () const =0
 Returns the class ID of the object. More...
 
virtual void serialize (ISerializer *serializer) const =0
 Serializes the object to the given serializer. More...
 
virtual void deserialize (IDeserializer *deserializer)=0
 Deserializes the object from the given deserializer. 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< 0x7a70f2fb, ... >
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< 0x7a70f2fb, ... >
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

All serializable objects have to be derived from this interface.

This allows to serialize them to a network stream, to disk etc. Some objects derived from this implement default functions for some of the member functions. This is the case if the class might be used locally only and never be stored to disk.

Member Function Documentation

 deserialize()

virtual void mi::neuraylib::ISerializable::deserialize ( IDeserializer deserializer)
pure virtual

Deserializes the object from the given deserializer.

The deserialization has to include all sub elements pointed to but serialized together with this object.

Implemented in mi::neuraylib::IFragmented_job.

 get_class_id()

virtual base::Uuid mi::neuraylib::ISerializable::get_class_id ( ) const
pure virtual

Returns the class ID of the object.

The class ID must be unique per registered class. It is used by the serializer to identify the class during serialization. The deserializer uses the class ID reconstruct a corresponding class instance during deserialization.

Returns
The class ID.

 serialize()

virtual void mi::neuraylib::ISerializable::serialize ( ISerializer serializer) const
pure virtual

Serializes the object to the given serializer.

The serialization has to include all sub elements pointed to but serialized together with this object.

Implemented in mi::neuraylib::IFragmented_job.