NVIDIA DeepStream SDK API Reference
9.1 Release
Public Types | Public Member Functions
ds3d::GuardDataLoader Class Reference

Detailed Description

GuardDataLoader is the safe access entry for abiDataLoader.

Applications can use it to make C-based APIs safer. it would manage abiRefDataLoader automatically. with that, App user do not need to refCopy_i or destroy abiRefDataLoader manually.

For example: abiRefDataLoader* rawRefLoader = creator(); GuardDataLoader guardLoader(rawRefLoader, true); // take the ownership of rawRefLoader guardLoader.setUserData(userdata, [](void*){ ...free... }); guardLoader.setErrorCallback([](ErrCode c, const char* msg){ stderr << msg; }); ErrCode c = guardLoader.start(config, path); DS_ASSERT(isGood(c)); c = guardLoader.start(config, path); // invoke abiDataLoader::start_i(...) GuardDataMap data; c = guardLoader.read(data); // invoke abiDataLoader::read_i(...) DS_ASSERT(isGood(c)); DS_ASSERT(data); ... // access data c = guardLoader.stop(); // invoke abiDataLoader::stop_i(...) guardLoader.reset(); // destroy abiRefDataLoader, when all reference // destroyed, abiDataLoader would be freed.

Definition at line 50 of file sources/includes/ds3d/common/hpp/dataloader.hpp.

Inheritance diagram for ds3d::GuardDataLoader:
Inheritance graph
[legend]
Collaboration diagram for ds3d::GuardDataLoader:
Collaboration graph
[legend]

Public Types

using abiRefType = abiRefT< abiDataLoader >
 
using abiRefType = abiRefT< abiDataLoader >
 

Public Member Functions

template<typename... Args>
 GuardDataLoader (Args &&... args)
 
 ~GuardDataLoader ()=default
 
std::string getOutputCaps ()
 
ErrCode readData (GuardDataMap &datamap)
 
ErrCode readDataAsync (abiOnDataCB::CppFunc dataReadyCB)
 
template<typename... Args>
 GuardDataLoader (Args &&... args)
 
 ~GuardDataLoader ()=default
 
std::string getOutputCaps ()
 
ErrCode readData (GuardDataMap &datamap)
 
ErrCode readDataAsync (abiOnDataCB::CppFunc dataReadyCB)
 
void setUserData (void *data, DelF delF)
 
void setUserData (void *data, DelF delF)
 
virtual void * getUserData () const
 
virtual void * getUserData () const
 
void setErrorCallback (abiErrorCB::CppFunc errCb)
 
void setErrorCallback (abiErrorCB::CppFunc errCb)
 
ErrCode start (const std::string &content, const std::string &path="")
 
ErrCode start (const std::string &content, const std::string &path="")
 
ErrCode flush ()
 
ErrCode flush ()
 
ErrCode stop ()
 
ErrCode stop ()
 
State state () const
 
State state () const
 
std::string getCaps (CapsPort port)
 
std::string getCaps (CapsPort port)
 
std::string getInputCaps ()
 
std::string getInputCaps ()
 
GuardTy cast ()
 
GuardTy cast ()
 
abiDataLoader * ptr () const
 
abiDataLoader * ptr () const
 
abiDataLoader * operator-> () const
 
abiDataLoader * operator-> () const
 
 operator bool () const
 
 operator bool () const
 
 operator ShrdPtr< abiDataLoader > ()
 
 operator ShrdPtr< abiDataLoader > ()
 
abiRefT< abiDataLoader > * release ()
 
abiRefT< abiDataLoader > * release ()
 
void reset (abiRefT< abiDataLoader > *abiref=nullptr)
 
void reset (abiRefT< abiDataLoader > *abiref=nullptr)
 
abiRefT< abiDataLoader > * abiRef () const
 
abiRefT< abiDataLoader > * abiRef () const
 

Member Typedef Documentation

◆ abiRefType [1/2]

using ds3d::GuardDataT< abiDataLoader >::abiRefType = abiRefT<abiDataLoader >
inherited

Definition at line 337 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ abiRefType [2/2]

using ds3d::GuardDataT< abiDataLoader >::abiRefType = abiRefT<abiDataLoader >
inherited

Definition at line 337 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

Constructor & Destructor Documentation

◆ GuardDataLoader() [1/2]

template<typename... Args>
ds3d::GuardDataLoader::GuardDataLoader ( Args &&...  args)
inline

Definition at line 56 of file sources/includes/ds3d/common/hpp/dataloader.hpp.

◆ ~GuardDataLoader() [1/2]

ds3d::GuardDataLoader::~GuardDataLoader ( )
default

◆ GuardDataLoader() [2/2]

template<typename... Args>
ds3d::GuardDataLoader::GuardDataLoader ( Args &&...  args)
inline

Definition at line 56 of file 9.1/sources/includes/ds3d/common/hpp/dataloader.hpp.

◆ ~GuardDataLoader() [2/2]

ds3d::GuardDataLoader::~GuardDataLoader ( )
default

Member Function Documentation

◆ abiRef() [1/2]

abiRefT< abiDataLoader > * ds3d::GuardRef< abiRefT< abiDataLoader > , >::abiRef
inlineinherited

Definition at line 273 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ abiRef() [2/2]

abiRefT< abiDataLoader > * ds3d::GuardRef< abiRefT< abiDataLoader > , >::abiRef
inlineinherited

Definition at line 273 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ cast() [1/2]

GuardTy ds3d::GuardDataT< abiDataLoader >::cast
inlineinherited

Definition at line 360 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ cast() [2/2]

GuardTy ds3d::GuardDataT< abiDataLoader >::cast
inlineinherited

Definition at line 360 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ flush() [1/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::flush
inlineinherited

Definition at line 80 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ flush() [2/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::flush
inlineinherited

Definition at line 80 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getCaps() [1/2]

std::string ds3d::GuardDataProcess< abiDataLoader , >::getCaps ( CapsPort  port)
inlineinherited

Definition at line 98 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getCaps() [2/2]

std::string ds3d::GuardDataProcess< abiDataLoader , >::getCaps ( CapsPort  port)
inlineinherited

Definition at line 98 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getInputCaps() [1/2]

std::string ds3d::GuardDataProcess< abiDataLoader , >::getInputCaps
inlineinherited

Definition at line 105 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getInputCaps() [2/2]

std::string ds3d::GuardDataProcess< abiDataLoader , >::getInputCaps
inlineinherited

Definition at line 105 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getOutputCaps() [1/2]

std::string ds3d::GuardDataLoader::getOutputCaps ( )
inline

Definition at line 61 of file 9.1/sources/includes/ds3d/common/hpp/dataloader.hpp.

References ds3d::cppString(), DS_ASSERT, ds3d::kOutput, and ds3d::GuardDataT< abiDataLoader >::ptr().

◆ getOutputCaps() [2/2]

std::string ds3d::GuardDataLoader::getOutputCaps ( )
inline

Definition at line 61 of file sources/includes/ds3d/common/hpp/dataloader.hpp.

References ds3d::cppString(), DS_ASSERT, ds3d::kOutput, and ds3d::GuardDataT< abiDataLoader >::ptr().

Referenced by ds3d::gst::NvDs3D_CreateDataLoaderSrc().

◆ getUserData() [1/2]

virtual void* ds3d::GuardDataProcess< abiDataLoader , >::getUserData
inlinevirtualinherited

Definition at line 59 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ getUserData() [2/2]

virtual void* ds3d::GuardDataProcess< abiDataLoader , >::getUserData
inlinevirtualinherited

Definition at line 59 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ operator bool() [1/2]

ds3d::GuardDataT< abiDataLoader >::operator bool
inlineinherited

Definition at line 374 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ operator bool() [2/2]

ds3d::GuardDataT< abiDataLoader >::operator bool
inlineinherited

Definition at line 374 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ operator ShrdPtr< abiDataLoader >() [1/2]

ds3d::GuardDataT< abiDataLoader >::operator ShrdPtr< abiDataLoader >
inlineinherited

Definition at line 376 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ operator ShrdPtr< abiDataLoader >() [2/2]

ds3d::GuardDataT< abiDataLoader >::operator ShrdPtr< abiDataLoader >
inlineinherited

Definition at line 376 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ operator->() [1/2]

abiDataLoader * ds3d::GuardDataT< abiDataLoader >::operator->
inlineinherited

Definition at line 372 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ operator->() [2/2]

abiDataLoader * ds3d::GuardDataT< abiDataLoader >::operator->
inlineinherited

Definition at line 372 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ ptr() [1/2]

abiDataLoader * ds3d::GuardDataT< abiDataLoader >::ptr
inlineinherited

Definition at line 365 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ ptr() [2/2]

abiDataLoader * ds3d::GuardDataT< abiDataLoader >::ptr
inlineinherited

Definition at line 365 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ readData() [1/2]

ErrCode ds3d::GuardDataLoader::readData ( GuardDataMap &  datamap)
inline

Definition at line 67 of file sources/includes/ds3d/common/hpp/dataloader.hpp.

References DS_ASSERT, ds3d::GuardDataT< abiDataLoader >::ptr(), ds3d::abiDataLoader::readData_i(), and ds3d::GuardRef< ref, >::reset().

◆ readData() [2/2]

ErrCode ds3d::GuardDataLoader::readData ( GuardDataMap &  datamap)
inline

Definition at line 67 of file 9.1/sources/includes/ds3d/common/hpp/dataloader.hpp.

References DS_ASSERT, ds3d::GuardDataT< abiDataLoader >::ptr(), ds3d::abiDataLoader::readData_i(), and ds3d::GuardRef< ref, >::reset().

◆ readDataAsync() [1/2]

ErrCode ds3d::GuardDataLoader::readDataAsync ( abiOnDataCB::CppFunc  dataReadyCB)
inline

Definition at line 76 of file sources/includes/ds3d/common/hpp/dataloader.hpp.

References ds3d::GuardRef< abiCB >::abiRef(), DS_ASSERT, ds3d::GuardDataT< abiDataLoader >::ptr(), ds3d::abiDataLoader::readDataAsync_i(), and ds3d::GuardCB< abiCB >::setFn().

◆ readDataAsync() [2/2]

ErrCode ds3d::GuardDataLoader::readDataAsync ( abiOnDataCB::CppFunc  dataReadyCB)
inline

Definition at line 76 of file 9.1/sources/includes/ds3d/common/hpp/dataloader.hpp.

References ds3d::GuardRef< abiCB >::abiRef(), DS_ASSERT, ds3d::GuardDataT< abiDataLoader >::ptr(), ds3d::abiDataLoader::readDataAsync_i(), and ds3d::GuardCB< abiCB >::setFn().

◆ release() [1/2]

abiRefT< abiDataLoader > * ds3d::GuardRef< abiRefT< abiDataLoader > , >::release
inlineinherited

Definition at line 257 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ release() [2/2]

abiRefT< abiDataLoader > * ds3d::GuardRef< abiRefT< abiDataLoader > , >::release
inlineinherited

Definition at line 257 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ reset() [1/2]

void ds3d::GuardRef< abiRefT< abiDataLoader > , >::reset ( abiRefT< abiDataLoader > *  abiref = nullptr)
inlineinherited

Definition at line 264 of file sources/includes/ds3d/common/hpp/obj.hpp.

◆ reset() [2/2]

void ds3d::GuardRef< abiRefT< abiDataLoader > , >::reset ( abiRefT< abiDataLoader > *  abiref = nullptr)
inlineinherited

Definition at line 264 of file 9.1/sources/includes/ds3d/common/hpp/obj.hpp.

◆ setErrorCallback() [1/2]

void ds3d::GuardDataProcess< abiDataLoader , >::setErrorCallback ( abiErrorCB::CppFunc  errCb)
inlineinherited

Definition at line 66 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ setErrorCallback() [2/2]

void ds3d::GuardDataProcess< abiDataLoader , >::setErrorCallback ( abiErrorCB::CppFunc  errCb)
inlineinherited

Definition at line 66 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ setUserData() [1/2]

void ds3d::GuardDataProcess< abiDataLoader , >::setUserData ( void *  data,
DelF  delF 
)
inlineinherited

Definition at line 48 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ setUserData() [2/2]

void ds3d::GuardDataProcess< abiDataLoader , >::setUserData ( void *  data,
DelF  delF 
)
inlineinherited

Definition at line 48 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ start() [1/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::start ( const std::string &  content,
const std::string &  path = "" 
)
inlineinherited

Definition at line 74 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ start() [2/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::start ( const std::string &  content,
const std::string &  path = "" 
)
inlineinherited

Definition at line 74 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ state() [1/2]

State ds3d::GuardDataProcess< abiDataLoader , >::state
inlineinherited

Definition at line 92 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ state() [2/2]

State ds3d::GuardDataProcess< abiDataLoader , >::state
inlineinherited

Definition at line 92 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ stop() [1/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::stop
inlineinherited

Definition at line 86 of file 9.1/sources/includes/ds3d/common/hpp/dataprocess.hpp.

◆ stop() [2/2]

ErrCode ds3d::GuardDataProcess< abiDataLoader , >::stop
inlineinherited

Definition at line 86 of file sources/includes/ds3d/common/hpp/dataprocess.hpp.

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