NVIDIA IndeX API nvidia_logo_transpbg.gif Up
Public Member Functions | List of all members
nv::index::IData_subset_factory Class Referenceabstract
NVIDIA IndeX API » Distributed Data Representation » Distributed Data Subsets

Factory for creating an empty data subset for a specific distributed dataset type. More...

#include <idistributed_data_subset.h>

Inherits mi::base::Interface_declare< 0x79c2f676, ... >.

Public Member Functions

virtual IDistributed_data_subset * create_data_subset (const mi::base::Uuid &dataset_type, const char *parameter) const =0
 Creates an instance that represents a subset of a large-scale dataset. More...
 
virtual IDistributed_data_subset * create_data_subset (const mi::base::Uuid &dataset_type, const IDistributed_data_attribute_set_descriptor *dataset_attrib_set_desc, const char *parameter) const =0
 Creates an instance that represents a subset of a large-scale dataset. More...
 
template<class T>
const T * create_data_subset (const char *parameter=0) const
 Convenience template function for creating and empty typed data subset instance. More...
 
template<class T>
T * create_data_subset (const char *parameter=0)
 Convenience template function for creating and empty typed data subset instance. More...
 
template<class T>
const T * create_data_subset (const IDistributed_data_attribute_set_descriptor *dataset_attrib_set_desc, const char *parameter=0) const
 Convenience template function for creating and empty typed data subset instance for a given attribute set descriptor. More...
 
template<class T>
T * create_data_subset (const IDistributed_data_attribute_set_descriptor *dataset_attrib_set_desc, const char *parameter=0)
 Convenience template function for creating and empty typed data subset instance for a given attribute set descriptor. More...
 
virtual IDistributed_data_attribute_set_descriptor * create_attribute_set_descriptor (const mi::base::Uuid &class_id) const =0
 Creates a specific attribute set descriptor instance. More...
 
template<class T>
T * create_attribute_set_descriptor ()
 Convenience template function for creating a typed attribute-set descriptor instance. More...
 

Detailed Description

Factory for creating an empty data subset for a specific distributed dataset type.

Instances of the distributed data subset interface (IDistributed_data_subset) can not be created by an application, the instantiation requires a factory that is provided by NVIDIA IndeX. The present interface IData_subset_factory allows an application to instantiate a distributed data subset by means of additional parameter. a
But the data import callback (IDistributed_data_import_callback) requires an application to create instances of subset of large-scale distributed datasets. The factory interface class IData_subset_factory creates these classes for the user based on the given UUID. An implementation of this class is passed as argument to the import callback method IDistributed_data_import_callback::create().

Note
The interface classes derived from IDistributed_data_subset cannot be instantiated beyond the library boundary, e.g., by an application.

Member Function Documentation

◆ create_attribute_set_descriptor() [1/2]

template<class T>
T * nv::index::IData_subset_factory::create_attribute_set_descriptor ( )
inline

Convenience template function for creating a typed attribute-set descriptor instance.

//
// Usage:
//
mi::base::Handle<nv::index::ISparse_volume_attribute_set_descriptor> attribute_set(
factory->create_attribute_set_descriptor<nv::index::ISparse_volume_attribute_set_descriptor>());
nv::index::ISparse_volume_attribute_set_descriptor
Attribute-set descriptor for sparse volume subsets.
Definition: isparse_volume_subset.h:129
Returns
Returns a typed attribute set descriptor.

◆ create_attribute_set_descriptor() [2/2]

virtual IDistributed_data_attribute_set_descriptor * nv::index::IData_subset_factory::create_attribute_set_descriptor ( const mi::base::Uuid &  class_id) const
pure virtual

Creates a specific attribute set descriptor instance.

Parameters
[in]class_idThe uuid specifies the attribute set descriptor type, e.g., ISparse_volume_attribute_set_descriptor, that shall be instantiated and returned.
Returns
Returns a specific attribute set descriptor. If the type is not support, then the method retuns a nullptr.

◆ create_data_subset() [1/6]

template<class T>
T * nv::index::IData_subset_factory::create_data_subset ( const char *  parameter = 0)
inline

Convenience template function for creating and empty typed data subset instance.

//
// Usage:
//
mi::base::Handle<nv::index::ISparse_volume_subset> attribute_set(
factory->create_data_subset<nv::index::ISparse_volume_subset>());
nv::index::ISparse_volume_subset
Distributed data storage class for sparse volume subsets.
Definition: isparse_volume_subset.h:286
Returns
Returns a typed data subset.

◆ create_data_subset() [2/6]

template<class T>
const T * nv::index::IData_subset_factory::create_data_subset ( const char *  parameter = 0) const
inline

Convenience template function for creating and empty typed data subset instance.

//
// Usage:
//
mi::base::Handle<const nv::index::ISparse_volume_subset> attribute_set(
factory->create_data_subset<nv::index::ISparse_volume_subset>());
Returns
Returns a typed data subset.

◆ create_data_subset() [3/6]

template<class T>
T * nv::index::IData_subset_factory::create_data_subset ( const IDistributed_data_attribute_set_descriptor *  dataset_attrib_set_desc,
const char *  parameter = 0 
)
inline

Convenience template function for creating and empty typed data subset instance for a given attribute set descriptor.

//
// Usage:
//
mi::base::Handle<nv::index::ISparse_volume_subset> attribute_set(
factory->create_data_subset<nv::index::ISparse_volume_subset>(descriptor, parameter));
Parameters
[in]dataset_attrib_set_descA attribute set descriptor.
[in]parameterOptional parameter string typically used to customizer the data subset creations.
Returns
Returns a typed data subset.

◆ create_data_subset() [4/6]

template<class T>
const T * nv::index::IData_subset_factory::create_data_subset ( const IDistributed_data_attribute_set_descriptor *  dataset_attrib_set_desc,
const char *  parameter = 0 
) const
inline

Convenience template function for creating and empty typed data subset instance for a given attribute set descriptor.

//
// Usage:
//
mi::base::Handle<const nv::index::ISparse_volume_subset> attribute_set(
factory->create_data_subset<nv::index::ISparse_volume_subset>(descriptor, parameter));
Parameters
[in]dataset_attrib_set_descA attribute set descriptor.
[in]parameterOptional parameter string typically used to customize the data subset creations.
Returns
Returns a typed data subset.

◆ create_data_subset() [5/6]

virtual IDistributed_data_subset * nv::index::IData_subset_factory::create_data_subset ( const mi::base::Uuid &  dataset_type,
const char *  parameter 
) const
pure virtual

Creates an instance that represents a subset of a large-scale dataset.

The instance is an implementation of the interface classes derived from IDistributed_data_subset. Common interface classes include a subset of a sparse volume (ISparse_volume_subset) or a patch of a regular heightfield (IRegular_heightfield_patch). The factory creates these instances based on just the UUID of these interface classes.

Parameters
[in]dataset_typeThe UUID of the interface class that represents a subset of a large-scale dataset.
[in]parameterCustom parameter string.
Returns
Created instance of an implementation of the interface class that represents the subset of the large-scale dataset.

◆ create_data_subset() [6/6]

virtual IDistributed_data_subset * nv::index::IData_subset_factory::create_data_subset ( const mi::base::Uuid &  dataset_type,
const IDistributed_data_attribute_set_descriptor *  dataset_attrib_set_desc,
const char *  parameter 
) const
pure virtual

Creates an instance that represents a subset of a large-scale dataset.

The instance is an implementation of the interface classes derived from IDistributed_data_subset. Common interface classes include a subset of a sparse volume (ISparse_volume_subset) or a patch of a regular heightfield (IRegular_heightfield_patch). The factory creates these instances based on just the UUID of these interface classes.

Parameters
[in]dataset_typeThe UUID of the interface class that represents a subset of a large-scale dataset.
[in]dataset_attrib_set_descCustom parameter string.
[in]parameterCustom parameter string.
Returns
Created instance of an implementation of the interface class that represents the subset of the large-scale dataset.
The documentation for this class was generated from the following file: