NVIDIA Iray API Home  Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
mi::bridge::IBridge_snapshot_context Class Referenceabstract
Bridge server

Context to import or remove snapshots. More...

Inheritance diagram for mi::bridge::IBridge_snapshot_context:
Inheritance graph
[legend]

Public Member Functions

virtual neuraylib::IImport_result *  import_snapshot (neuraylib::ITransaction *transaction, const char *snapshot_id, const IMap *importer_options=0)=0
  Imports a previously saved snapshot from the disk cache. More...
 
virtual Sint32  remove_snapshot (const char *snapshot_id)=0
  Removes a previously save snapshot from the disk cache. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x9a9ceafe, 0x876b, 0x4647, 0xbc, 0xae, 0xb6, 0x4, 0x9c, 0x7b, 0x9, 0xfc >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface > 		 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< 0x9a9ceafe, 0x876b, 0x4647, 0xbc, 0xae, 0xb6, 0x4, 0x9c, 0x7b, 0x9, 0xfc >
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

Context to import or remove snapshots.

See Also
mi::bridge::IBridge_server::create_snapshot_context()

Member Function Documentation

virtual neuraylib::IImport_result* mi::bridge::IBridge_snapshot_context::import_snapshot ( neuraylib::ITransaction *  transaction,
const char *  snapshot_id,
const IMap *  importer_options = 0 
)
pure virtual

Imports a previously saved snapshot from the disk cache.

This method is similar to using mi::neuraylib::IImport_api::import_elements(), but will load a previously saved snapshot from the disk cache. In the case of incremental snapshots the base snapshot must be loaded first, and then each incremental snapshot in sequence.

Parameters
transaction The transaction into which to import the elements.
snapshot_id The ID of the snapshot to import.
importer_options Optional importer options.
Returns
Result of the import operation with the following error codes:
  • 0: Success.
  • 4001: Invalid parameters.
  • 4002: Failed to open the disk cache.
  • 4003: There is no snapshot with the given ID in this disk cache.
  • 4004: Snapshot has an incompatible Bridge version.
  • 4005: Failed to import the snapshot elements.
  • >= 4006: Unspecified error.
virtual Sint32 mi::bridge::IBridge_snapshot_context::remove_snapshot ( const char *  snapshot_id)
pure virtual

Removes a previously save snapshot from the disk cache.

Parameters
snapshot_id The ID of the snapshot to remove.
Returns
  • 0: Success.
  • -1: Invalid parameters.
  • -2: Failed to open the disk cache.
  • -3: There is no snapshot with the given ID in this disk cache.
  • <= -4: Unspecified error