This mixin class can be used to implement the IDistributed_data_import_callback interface. More...

#include <idistributed_data_import_callback.h>

Inherits mi::neuraylib::Base< id1, ... >.

Public Member Functions
virtual mi::Size	estimate (const mi::math::Bbox_struct< mi::Sint32, 3 > &bounding_box, mi::neuraylib::IDice_transaction *dice_transaction) const =0
	Shall provide the size of the dataset that is contained in the given bounding box. More...

virtual mi::Size	estimate (const mi::math::Bbox_struct< mi::Float32, 3 > &bounding_box, mi::neuraylib::IDice_transaction *dice_transaction) const
	Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant. More...

virtual IDistributed_data_subset *	create (const mi::math::Bbox_struct< mi::Sint32, 3 > &bounding_box, IData_subset_factory factory, mi::neuraylib::IDice_transaction dice_transaction) const =0
	Shall create and provide the dataset subset contained in the given bounding box. More...

virtual IDistributed_data_subset *	create (const mi::math::Bbox_struct< mi::Float32, 3 > &bounding_box, IData_subset_factory factory, mi::neuraylib::IDice_transaction dice_transaction) const
	Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant. More...

virtual IDistributed_data_subset *	create (const mi::math::Bbox_struct< mi::Sint32, 3 > &bounding_box, mi::Uint32 time_step, IData_subset_factory factory, mi::neuraylib::IDice_transaction dice_transaction) const
	Shall create and provide the dataset subset contained in the given bounding box for a given time step. More...

virtual IDistributed_data_subset *	create (const mi::math::Bbox_struct< mi::Float32, 3 > &bounding_box, mi::Uint32 time_step, IData_subset_factory factory, mi::neuraylib::IDice_transaction dice_transaction) const
	Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant. More...

virtual void	serialize (mi::neuraylib::ISerializer *serializer) const
	Empty body, i.e., no member data is serialized. More...

virtual void	deserialize (mi::neuraylib::IDeserializer *deserializer)
	Empty body, i.e., no member data is deserialized. More...

const IDistributed_data_properties *	get_dataset_properties () const
	Empty body, i.e., no data properties exposed. More...

virtual const char *	get_configuration () const
	Empty body, i.e., no configuration for the session exporter given. More...

Detailed Description

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>
class nv::index::Distributed_discrete_data_import_callback< id1, ... >

This mixin class can be used to implement the IDistributed_data_import_callback interface.

This mixin class provides a default implementation of some of the pure virtual methods of the IDistributed_data_import_callbacks. The documentation here just lists the behavior of the default implementation, see IDistributed_data_import_callback for the documentation of the methods themselves.

Member Function Documentation

^◆ create() [1/4]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual IDistributed_data_subset * nv::index::Distributed_discrete_data_import_callback< id1, ... >::create	(	const mi::math::Bbox_struct< mi::Float32, 3 > &	bounding_box,
		IData_subset_factory *	factory,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

inlinevirtual

Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant.

Parameters

[in]	bounding_box	The 3D area for which data shall be imported. The bounding box is given in the dataset's local space.
[in]	factory	A factory class that creates a dataset subset of a given kind on request (see also `subset_id()`).
[in]	dice_transaction	The DiCE database transaction that the operation runs in. The transaction may be invalid indicating an asynchronous data import operation.

Returns: Returns the portion of the dataset contained in the 3D area.

^◆ create() [2/4]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual IDistributed_data_subset * nv::index::Distributed_discrete_data_import_callback< id1, ... >::create	(	const mi::math::Bbox_struct< mi::Float32, 3 > &	bounding_box,
		mi::Uint32	time_step,
		IData_subset_factory *	factory,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

inlinevirtual

Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant.

Parameters

[in]	bounding_box	The 3D area for which data shall be imported. The bounding box is given in the dataset's local space.
[in]	time_step	The time step for which data shall be imported.
[in]	factory	A factory class that creates a dataset subset of a given kind on request (see also `subset_id()`).
[in]	dice_transaction	The DiCE database transaction that the operation runs in. The transaction may be invalid indicating an asynchronous data import operation.

Returns: Returns the portion of the dataset contained in the 3D area.

^◆ create() [3/4]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual IDistributed_data_subset * nv::index::Distributed_discrete_data_import_callback< id1, ... >::create	(	const mi::math::Bbox_struct< mi::Sint32, 3 > &	bounding_box,
		IData_subset_factory *	factory,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

pure virtual

Shall create and provide the dataset subset contained in the given bounding box.

Parameters

[in]	bounding_box	The 3D area for which data shall be imported. The bounding box is given in the dataset's local space.
[in]	factory	A factory class that creates a dataset subset of a given kind on request (see also `subset_id()`).
[in]	dice_transaction	The DiCE database transaction that the operation runs in. The transaction may be invalid indicating an asynchronous data import operation.

Returns: Returns the portion of the dataset contained in the 3D area.

^◆ create() [4/4]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual IDistributed_data_subset * nv::index::Distributed_discrete_data_import_callback< id1, ... >::create	(	const mi::math::Bbox_struct< mi::Sint32, 3 > &	bounding_box,
		mi::Uint32	time_step,
		IData_subset_factory *	factory,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

inlinevirtual

Shall create and provide the dataset subset contained in the given bounding box for a given time step.

Parameters

[in]	bounding_box	The 3D area for which data shall be imported. The bounding box is given in the dataset's local space.
[in]	time_step	The time step for which data shall be imported.
[in]	factory	A factory class that creates a dataset subset of a given kind on request (see also `subset_id()`).
[in]	dice_transaction	The DiCE database transaction that the operation runs in. The transaction may be invalid indicating an asynchronous data import operation.

Returns: Returns the portion of the dataset contained in the 3D area.

^◆ deserialize()

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual void nv::index::Distributed_discrete_data_import_callback< id1, ... >::deserialize ( mi::neuraylib::IDeserializer * deserializer )

inlinevirtual

Empty body, i.e., no member data is deserialized.

Parameters

[in] deserializer unused

^◆ estimate() [1/2]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual mi::Size nv::index::Distributed_discrete_data_import_callback< id1, ... >::estimate	(	const mi::math::Bbox_struct< mi::Float32, 3 > &	bounding_box,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

inlinevirtual

Implementation maps floating-point bounding box to a signed integer bounding box and call respective variant.

Parameters

[in]	bounding_box	The bounding box of the subset in the dataset's local space.
[in]	dice_transaction	he DiCE database transaction that the operation runs in.

Returns: Returns the approximate number of items contained in the given 3D area.

^◆ estimate() [2/2]

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual mi::Size nv::index::Distributed_discrete_data_import_callback< id1, ... >::estimate	(	const mi::math::Bbox_struct< mi::Sint32, 3 > &	bounding_box,
		mi::neuraylib::IDice_transaction *	dice_transaction
	)		const

pure virtual

Shall provide the size of the dataset that is contained in the given bounding box.

The size should approximate the number of primary items in the bounding box (e.g. voxels, cells, pixels). If the size is zero, the bounding box region will be seen as empty, and not considered for further processing.

Parameters

[in]	bounding_box	The bounding box of the subset in the dataset's local space.
[in]	dice_transaction	The DiCE database transaction that the operation runs in.

Returns: Returns the approximate number of items contained in the given 3D area.

^◆ get_configuration()

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual const char * nv::index::Distributed_discrete_data_import_callback< id1, ... >::get_configuration ( ) const

inlinevirtual

Empty body, i.e., no configuration for the session exporter given.

^◆ get_dataset_properties()

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

const IDistributed_data_properties * nv::index::Distributed_discrete_data_import_callback< id1, ... >::get_dataset_properties ( ) const

inline

Empty body, i.e., no data properties exposed.

^◆ serialize()

template<mi::Uint32 id1, mi::Uint16 id2, mi::Uint16 id3, mi::Uint8 id4, mi::Uint8 id5, mi::Uint8 id6, mi::Uint8 id7, mi::Uint8 id8, mi::Uint8 id9, mi::Uint8 id10, mi::Uint8 id11, class I = IDistributed_data_import_callback>

virtual void nv::index::Distributed_discrete_data_import_callback< id1, ... >::serialize ( mi::neuraylib::ISerializer * serializer ) const

inlinevirtual

Empty body, i.e., no member data is serialized.

Parameters

[in] serializer unused.

The documentation for this class was generated from the following file:

idistributed_data_import_callback.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ create() [1/4]

◆ create() [2/4]

◆ create() [3/4]

◆ create() [4/4]

◆ deserialize()

◆ estimate() [1/2]

◆ estimate() [2/2]

◆ get_configuration()

◆ get_dataset_properties()

◆ serialize()

^◆ create() [1/4]

^◆ create() [2/4]

^◆ create() [3/4]

^◆ create() [4/4]

^◆ deserialize()

^◆ estimate() [1/2]

^◆ estimate() [2/2]

^◆ get_configuration()

^◆ get_dataset_properties()

^◆ serialize()