NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream::PreprocessBatchUserMetadata Class Reference

Detailed Description

User metadata for preprocess batch.

This user metadata object is associated with a preprocess batch structure

Definition at line 532 of file service-maker/includes/metadata.hpp.

Inheritance diagram for deepstream::PreprocessBatchUserMetadata:
Collaboration diagram for deepstream::PreprocessBatchUserMetadata:

Public Types

typedef std::unique_ptr< AbstractIterator< UserMetadata > > Iterator
 
typedef std::unique_ptr< AbstractIterator< UserMetadata > > Iterator
 

Public Member Functions

 PreprocessBatchUserMetadata (void *data=nullptr)
 
 PreprocessBatchUserMetadata (const UserMetadata &)
 
virtual ~PreprocessBatchUserMetadata ()
 
std::vector< unsigned int > getTargetUniqueIds () const
 @Brief Get the target unique ids More...
 
std::vector< RoiMetadatagetRois () const
 Get the roi list. More...
 
PreprocessTensorMetadata getPreprocessTensorMetadata () const
 Get the preprocess tensor metadata. More...
 
bool initPreprocessTensorMetadata (const std::string &name, unsigned int meta_id, unsigned int unique_id, Tensor *tensor)
 Initialize a preprocess tensor metadata. More...
 
 PreprocessBatchUserMetadata (void *data=nullptr)
 
 PreprocessBatchUserMetadata (const UserMetadata &)
 
virtual ~PreprocessBatchUserMetadata ()
 
std::vector< unsigned int > getTargetUniqueIds () const
 @Brief Get the target unique ids More...
 
std::vector< RoiMetadatagetRois () const
 Get the roi list. More...
 
PreprocessTensorMetadata getPreprocessTensorMetadata () const
 Get the preprocess tensor metadata. More...
 
bool initPreprocessTensorMetadata (const std::string &name, unsigned int meta_id, unsigned int unique_id, Tensor *tensor)
 Initialize a preprocess tensor metadata. More...
 
virtual operator bool () override
 operator to check if a metadata is void More...
 
virtual operator bool () override
 operator to check if a metadata is void More...
 
int metaType () const
 Get the meta type. More...
 
int metaType () const
 Get the meta type. More...
 
void setMetaType (int type)
 Set the meta type. More...
 
void setMetaType (int type)
 Set the meta type. More...
 
void * userData () const
 Get the user data pointer. More...
 
void * userData () const
 Get the user data pointer. More...
 
void setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
 Set user data with copy and release functions. More...
 
void setUserData (void *data, void *(*copy)(void *, void *), void(*release)(void *, void *))
 Set user data with copy and release functions. More...
 

Protected Member Functions

void get_ (void *&)
 
void get_ (void *&)
 

Protected Attributes

void * data_
 

Member Typedef Documentation

◆ Iterator [1/2]

Definition at line 103 of file service-maker/includes/metadata.hpp.

◆ Iterator [2/2]

Definition at line 103 of file 9.0/service-maker/includes/metadata.hpp.

Constructor & Destructor Documentation

◆ PreprocessBatchUserMetadata() [1/4]

deepstream::PreprocessBatchUserMetadata::PreprocessBatchUserMetadata ( void *  data = nullptr)

◆ PreprocessBatchUserMetadata() [2/4]

deepstream::PreprocessBatchUserMetadata::PreprocessBatchUserMetadata ( const UserMetadata )

◆ ~PreprocessBatchUserMetadata() [1/2]

virtual deepstream::PreprocessBatchUserMetadata::~PreprocessBatchUserMetadata ( )
virtual

◆ PreprocessBatchUserMetadata() [3/4]

deepstream::PreprocessBatchUserMetadata::PreprocessBatchUserMetadata ( void *  data = nullptr)

◆ PreprocessBatchUserMetadata() [4/4]

deepstream::PreprocessBatchUserMetadata::PreprocessBatchUserMetadata ( const UserMetadata )

◆ ~PreprocessBatchUserMetadata() [2/2]

virtual deepstream::PreprocessBatchUserMetadata::~PreprocessBatchUserMetadata ( )
virtual

Member Function Documentation

◆ get_() [1/2]

◆ get_() [2/2]

void deepstream::UserMetadata::get_ ( void *&  )
protectedinherited

◆ getPreprocessTensorMetadata() [1/2]

PreprocessTensorMetadata deepstream::PreprocessBatchUserMetadata::getPreprocessTensorMetadata ( ) const

Get the preprocess tensor metadata.

◆ getPreprocessTensorMetadata() [2/2]

PreprocessTensorMetadata deepstream::PreprocessBatchUserMetadata::getPreprocessTensorMetadata ( ) const

Get the preprocess tensor metadata.

◆ getRois() [1/2]

std::vector<RoiMetadata> deepstream::PreprocessBatchUserMetadata::getRois ( ) const

Get the roi list.

◆ getRois() [2/2]

std::vector<RoiMetadata> deepstream::PreprocessBatchUserMetadata::getRois ( ) const

Get the roi list.

◆ getTargetUniqueIds() [1/2]

std::vector<unsigned int> deepstream::PreprocessBatchUserMetadata::getTargetUniqueIds ( ) const

@Brief Get the target unique ids

◆ getTargetUniqueIds() [2/2]

std::vector<unsigned int> deepstream::PreprocessBatchUserMetadata::getTargetUniqueIds ( ) const

@Brief Get the target unique ids

◆ initPreprocessTensorMetadata() [1/2]

bool deepstream::PreprocessBatchUserMetadata::initPreprocessTensorMetadata ( const std::string &  name,
unsigned int  meta_id,
unsigned int  unique_id,
Tensor tensor 
)

Initialize a preprocess tensor metadata.

◆ initPreprocessTensorMetadata() [2/2]

bool deepstream::PreprocessBatchUserMetadata::initPreprocessTensorMetadata ( const std::string &  name,
unsigned int  meta_id,
unsigned int  unique_id,
Tensor tensor 
)

Initialize a preprocess tensor metadata.

◆ metaType() [1/2]

int deepstream::UserMetadata::metaType ( ) const
inherited

Get the meta type.

◆ metaType() [2/2]

int deepstream::UserMetadata::metaType ( ) const
inherited

Get the meta type.

◆ operator bool() [1/2]

virtual deepstream::UserMetadata::operator bool ( )
inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ operator bool() [2/2]

virtual deepstream::UserMetadata::operator bool ( )
inlineoverridevirtualinherited

operator to check if a metadata is void

Reimplemented from deepstream::Metadata.

Definition at line 116 of file 9.0/service-maker/includes/metadata.hpp.

References deepstream::Metadata::data_.

◆ setMetaType() [1/2]

void deepstream::UserMetadata::setMetaType ( int  type)
inherited

Set the meta type.

◆ setMetaType() [2/2]

void deepstream::UserMetadata::setMetaType ( int  type)
inherited

Set the meta type.

◆ setUserData() [1/2]

void deepstream::UserMetadata::setUserData ( void *  data,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  release 
)
inherited

Set user data with copy and release functions.

Parameters
dataPointer to user data
copyCopy function for the user data (can be NULL)
releaseRelease function for the user data (can be NULL)

◆ setUserData() [2/2]

void deepstream::UserMetadata::setUserData ( void *  data,
void *(*)(void *, void *)  copy,
void(*)(void *, void *)  release 
)
inherited

Set user data with copy and release functions.

Parameters
dataPointer to user data
copyCopy function for the user data (can be NULL)
releaseRelease function for the user data (can be NULL)

◆ userData() [1/2]

void* deepstream::UserMetadata::userData ( ) const
inherited

Get the user data pointer.

◆ userData() [2/2]

void* deepstream::UserMetadata::userData ( ) const
inherited

Get the user data pointer.

Field Documentation

◆ data_

void * deepstream::Metadata::data_
protectedinherited

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