DiCE API nvidia_logo_transpbg.gif Up
mi::neuraylib Namespace Reference

Namespace for the DiCE API. More...

Classes

class  Base
 This mixin class can be used to implement the mi::base::IInterface interface. More...
 
class  Element
 This mixin class can be used to implement the mi::neuraylib::IElement interface. More...
 
class  Fragmented_job
 This mixin class can be used to implement the mi::neuraylib::IFragmented_job interface. More...
 
class  IAllocator
 The Allocator interface class supports allocating and releasing memory dynamically and querying the amount of extra memory used in the integrating application. More...
 
class  ICache_manager
 Represents an instance of the cache manager. More...
 
class  ICache_manager_factory
 This factory allows to create cache manager instances. More...
 
class  ICanvas
 Abstract interface for a canvas represented by a rectangular array of tiles. More...
 
class  ICanvas_base
 Abstract interface for a canvas (base class). More...
 
class  ICanvas_cuda
 Abstract interface for a canvas with CUDA device memory storage. More...
 
class  IChild_process_resolver
 A filter used to decide if a command string to start a child process is eligible for execution. More...
 
class  IClient_node_callback
 Abstract interface for signaling changed cluster members. More...
 
class  ICluster
 This class represents an additional cluster to be used for storing data, communicating, and executing jobs. More...
 
class  ICluster_descriptor
 This interface describes a cluster and its properties. More...
 
class  ICluster_factory
 This API component is used to create additional clusters. More...
 
class  ICluster_filter
 A filter used to decide whether a cluster is eligible to be joined. More...
 
class  ICluster_manager_cluster
 Represents a cluster which was reserved through the cluster manager. More...
 
class  ICluster_manager_configuration
 An API component which can be used to create a connection to a cluster manager. More...
 
class  ICluster_manager_connection
 Represents a connection to a cluster manager. More...
 
class  ICluster_manager_node
 Provides information about a node which is part of a node pool or reserved cluster. More...
 
class  ICluster_notification_callback
 Abstract interface for giving notifications about errors and status changes. More...
 
class  ICluster_pool_information
 Represents a pool of nodes managed though the cluster manager. More...
 
class  ICluster_property_callback
 Abstract interface for signaling changed cluster properties. More...
 
class  IDatabase
 This interface is used to interact with the distributed database. More...
 
class  IDatabase_configuration
 This interface is used to query and change the database configuration. More...
 
class  IDebug_configuration
 This interface represents an interface to set debug options. More...
 
class  IDeserializer
 Source for deserializing objects from byte streams. More...
 
class  IDice_configuration
 This interface allows configuration of DiCE. More...
 
class  IDice_transaction
 A transaction provides a consistent view on the database. More...
 
class  IDistributed_cache
 The distributed cache service can be used to create temporary objects in a cluster. More...
 
class  IElement
 This interface represents the abstract base class for all database elements. More...
 
class  IExecution_listener
 A callback interface used for asynchronous execution of fragmented jobs. More...
 
class  IExtension_api
 This interface is used to extent the DiCE API. More...
 
class  IFactory
 This API component allows the creation, assignment, and cloning of instances of types. More...
 
class  IFragmented_job
 This interface represents the base class for all fragmented jobs. More...
 
class  IGeneral_configuration
 This interface is used to query and change the general configuration. More...
 
class  IGpu_description
 This interface describes a GPU. More...
 
class  IHead_node_callback
 Abstract interface for signaling a change of the cluster application head node. More...
 
class  IHost_callback
 Abstract interface to report cluster status changes. More...
 
class  IHost_properties
 This interface contains information about a local or remote host. More...
 
class  IImage_api
 This interface provides various utilities related to canvases and buffers. More...
 
class  IJob
 This interface represents the base class for all database jobs. More...
 
class  IJob_execution_context
 Provides information about the context in which a job is executed. More...
 
class  ILibrary_authenticator
 This interface is used for authenticating the application against the library. More...
 
class  ILogging_configuration
 This interface is used for configuring the logging for the DiCE library. More...
 
class  INetwork_configuration
 This interface is used to query and change the networking configuration. More...
 
class  INetwork_statistics
 This interface is used to inquire statistics about the network usage etc. More...
 
class  INeuray
 This is an object representing the DiCE library. More...
 
class  INode_manager_client
 The node manager client allows to start or join DiCE clusters built from worker nodes. More...
 
class  INode_manager_cluster
 The interface to a cluster created and managed by the node manager. More...
 
class  INode_manager_factory
 Factory to create node manager client and worker instances. More...
 
class  INode_manager_worker
 The node manager worker class allows to set properties and announce them to other nodes. More...
 
class  IObject_receiver
 The object receiver is responsible for creation and destruction of objects on the remote host. More...
 
class  IPlugin
 The basic interface to be implemented by DiCE API plugins. More...
 
class  IPlugin_api
 This abstract interface gives access to the DiCE API to plugins. More...
 
class  IPlugin_configuration
 This interface is used to load plugins and to query information about loaded plugins. More...
 
class  IRDMA_buffer
 An RDMA buffer represents a piece of pinned memory which can be used to transfer data over RDMA. More...
 
class  IRDMA_context
 The RDMA context works as a cache for RDMA buffers. More...
 
class  IScheduler
 The scheduler allows to execute fragmented jobs. More...
 
class  IScheduling_configuration
 This interface is used to query and change the scheduling configuration. More...
 
class  IScope
 A scope is the context which determines the visibility of database elements. More...
 
class  ISerializable
 All serializable objects have to be derived from this interface. More...
 
class  ISerializer
 Target for serializing objects to byte streams. More...
 
class  IShutdown_cluster_callback
 Abstract interface for signaling a request to shutdown a cluster. More...
 
class  IShutdown_node_managers_callback
 Abstract interface for signaling a request to shutdown all clients and workers. More...
 
class  ISoftware_package
 Represents a software package installed on the pool of nodes. More...
 
class  ITag_set
 Used to store a set of tags. More...
 
class  ITile
 Abstract interface for a tile. More...
 
class  ITimer
 This is an abstract interface class for a timer. More...
 
class  ITimer_class_factory
 The registration of a timer class requires a factory which constructs an instance during deserialization. More...
 
class  ITimer_configuration
 This class is used to start and stop timers. More...
 
class  IUser_class
 Abstract interface for user-defined classes. More...
 
class  IUser_class_factory
 Abstract interface for user class factories. More...
 
class  IVersion
 Abstract interface for accessing version information. More...
 
class  IVideo_codec_factory
 API component that allow creation of installed video encoders and decoders. More...
 
class  IVideo_data
 A buffer for video data representing a frame. More...
 
class  IVideo_decoder
 Abstract interface for video decoders. More...
 
class  IVideo_encoder
 Abstract interface for video encoders. More...
 
class  IVideo_plugin
 Abstract interface for video encoder plugins. More...
 
class  IWorker_node_callback
 Abstract interface for signaling changed cluster members. More...
 
class  IWorker_node_descriptor
 This interface describes a worker node and its properties. More...
 
class  IWorker_node_filter
 A filter used to decide whether a worker node is eligible to be included in a cluster. More...
 
class  IWorker_node_property_callback
 Abstract interface for signaling changed worker node properties. More...
 
class  IWorker_process_started_callback
 Abstract interface for indicating that a worker process has been fully started. More...
 
class  Job
 This mixin class can be used to implement the mi::neuraylib::IJob interface. More...
 
class  Tag
 A tag represents a unique identifier for database elements in the database. More...
 
struct  Tag_struct
 A tag represents a unique identifier for database elements in the database. More...
 
class  Timer_class_factory
 This mixin class provides a default implementation of the mi::neuraylib::ITimer_class_factory interface. More...
 
class  User_class
 This mixin class should be used to implement the IUser_class interface. More...
 
class  User_class_factory
 This mixin class provides a default implementation of the IUser_class_factory interface. More...
 

Typedefs

typedef Uint8 Privacy_level
 The privacy level is an unsigned 8 bit integer. More...
 

Enumerations

enum  Log_prefix {
  LOG_PREFIX_TIME = 0x0001 ,
  LOG_PREFIX_TIME_SECONDS = 0x0002 ,
  LOG_PREFIX_HOST_THREAD = 0x0004 ,
  LOG_PREFIX_HOST_NAME = 0x0008 ,
  LOG_PREFIX_MODULE = 0x0010 ,
  LOG_PREFIX_CATEGORY = 0x0020 ,
  LOG_PREFIX_SEVERITY = 0x0040 ,
  LOG_PREFIX_CUDA_DEVICE = 0x0080 ,
  LOG_PREFIX_TAGS = 0x0100 ,
  LOG_PREFIX_FORCE_32_BIT = 0xffffffffU
}
 Components of the log message prefix. More...
 

Functions

template<class T>
T * mi_factory (void *symbol)
 Convenience function to ease the use of mi_factory(). More...
 
Uint32_2 get_resolution (const ICanvas_base &canvas)
 Convenience function which returns a canvas' resolution in a struct. More...
 
bool operator== (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is equal to rhs. More...
 
bool operator!= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is not equal to rhs. More...
 
bool operator< (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is less than rhs. More...
 
bool operator> (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is greater than rhs. More...
 
bool operator<= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is less than or equal to rhs. More...
 
bool operator>= (const Tag &lhs, const Tag &rhs)
 Returns true if lhs is greater than or equal to rhs. More...
 

Variables

const Tag NULL_TAG
 This value of the tag represents an invalid tag which can not be accessed. More...
 

Detailed Description

Namespace for the DiCE API.

Function Documentation

 mi_factory()

template<class T>
T * mi::neuraylib::mi_factory ( void *  symbol)

Convenience function to ease the use of mi_factory().

Parameters
symbolpointer to the mi_factory symbol.
Returns
a pointer to an interface of type T or NULL if the interface could not be retrieved. See mi_factory for supported interfaces.