NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::Distributed_data_subset_locality_query_mode Class Reference

Implements a query method that selection all data subsets of a distributed dataset covered by a region of interest. More...

#include <idistributed_data_locality.h>

Inherits mi::base::Interface_implement< nv::index::IDistributed_data_subset_locality_query_mode >.

Public Member Functions

 Distributed_data_subset_locality_query_mode (const mi::neuraylib::Tag_struct &tag, const mi::math::Bbox_struct< mi::Float32, 3 > &coverage)
 Instantiating a query method using the distributed dataset unique identifier and a given region of interest. More...
 
 Distributed_data_subset_locality_query_mode (const mi::neuraylib::Tag_struct &tag, const mi::math::Bbox_struct< mi::Sint32, 3 > &coverage)
 Instantiating a query method using the distributed dataset unique identifier and a given region of interest. More...
 
virtual ~Distributed_data_subset_locality_query_mode ()
 Implements an empty default destructor. More...
 
virtual const mi::neuraylib::Tag_struct & get_distributed_data_tag () const
 Implements the query method that applies to a distributed dataset that is referred to by an unique identifier. More...
 
virtual mi::Uint32 get_query_mode_flags () const
 Implements the default query flags. More...
 
virtual const mi::math::Bbox_struct< mi::Float32, 3 > & get_spatial_coverage () const
 Implements the spatial query method let determine data localities based on a spatial coverage. More...
 

Detailed Description

Implements a query method that selection all data subsets of a distributed dataset covered by a region of interest.

The class Distributed_data_subset_locality_query_mode implements the base class IDistributed_data_subset_locality_query_mode. The purpose of the implementation is to conveniently determine all data subsets of a distributed dataset that are inside or intersect a given spatial area.

Constructor & Destructor Documentation

 Distributed_data_subset_locality_query_mode() [1/2]

nv::index::Distributed_data_subset_locality_query_mode::Distributed_data_subset_locality_query_mode ( const mi::neuraylib::Tag_struct &  tag,
const mi::math::Bbox_struct< mi::Float32, 3 > &  coverage 
)
inline

Instantiating a query method using the distributed dataset unique identifier and a given region of interest.

The spatial query is defined in continuous space which requires a bounding box defined using floating-point min and max values.

Parameters
[in]tagThe mi::neuraylib::Tag_struct identifies the distributed dataset.
[in]coverageThe bounding box specifies the region of interest for the locality query.

 Distributed_data_subset_locality_query_mode() [2/2]

nv::index::Distributed_data_subset_locality_query_mode::Distributed_data_subset_locality_query_mode ( const mi::neuraylib::Tag_struct &  tag,
const mi::math::Bbox_struct< mi::Sint32, 3 > &  coverage 
)
inline

Instantiating a query method using the distributed dataset unique identifier and a given region of interest.

The spatial query is defined in continuous space but the region of interest here is defined using integer min and max values. The bounding box is converted to a floating-point bounding box first.

Parameters
[in]tagThe mi::neuraylib::Tag_struct identifies the distributed dataset.
[in]coverageThe bounding box specifies the region of interest for the locality query.

 ~Distributed_data_subset_locality_query_mode()

virtual nv::index::Distributed_data_subset_locality_query_mode::~Distributed_data_subset_locality_query_mode ( )
inlinevirtual

Implements an empty default destructor.

Member Function Documentation

 get_distributed_data_tag()

virtual const mi::neuraylib::Tag_struct & nv::index::Distributed_data_subset_locality_query_mode::get_distributed_data_tag ( ) const
inlinevirtual

Implements the query method that applies to a distributed dataset that is referred to by an unique identifier.

Returns
Return the mi::neuraylib::Tag_struct that uniquely identifies the entire distributed dataset.

 get_query_mode_flags()

virtual mi::Uint32 nv::index::Distributed_data_subset_locality_query_mode::get_query_mode_flags ( ) const
inlinevirtual

Implements the default query flags.

Returns
Return the default query flags IDistributed_data_locality_query_mode::QUERY_MODE_DEFAULT

 get_spatial_coverage()

virtual const mi::math::Bbox_struct< mi::Float32, 3 > & nv::index::Distributed_data_subset_locality_query_mode::get_spatial_coverage ( ) const
inlinevirtual

Implements the spatial query method let determine data localities based on a spatial coverage.

The bounding box represented by mi::math::Bbox_struct<mi::Float32, 3> specify a spatial region of interest. All data subsets that are covered at least partially, will be considered in a data locality.

Returns
Returns the a bounding box that represents a region of interest for determining the data locality. An invalid bounding box will be ignored and the space that the entire distributed dataset covers will be considered instead.

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