NVIDIA DeepStream SDK API Reference

9.2 Release
ds3d::GuardDataRender Class Reference

Detailed Description

GuardDataRender is the safe access entry for abiDataRender.

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

For example: abiRefDataRender* rawRefRender = createRender(); GuardDataRender guardRender(rawRefRender, true); // take the ownership of rawRefRender guardRender.setUserData(userdata, [](void*){ ...free... }); guardRender.setErrorCallback([](ErrCode c, const char* msg){ stderr << msg; }); ErrCode c = guardRender.start(config, path); DS_ASSERT(isGood(c)); c = guardRender.start(config, path); // invoke abiDataRender::start_i(...) GuardDataMap data = ...; c = guardRender.preroll(data); // invoke abiDataRender::preroll_i(...) DS_ASSERT(isGood(c)); // invoke abiDataRender::render_i(...) c = guardRender.render(data, [](ErrCode c, const abiRefDataMap* d){ GuardDataMap doneData(*d); // check ErrCode and data. }); DS_ASSERT(isGood(c)); c = guardRender.flush(); // flush all data in queue c = guardRender.stop(); // invoke abiDataRender::stop_i(...) guardRender.reset(); // destroy abiRefDataRender, when all reference // destroyed, abiDataRender would be freed.

Definition at line 57 of file includes/ds3d/common/hpp/datarender.hpp.

Inheritance diagram for ds3d::GuardDataRender:
Collaboration diagram for ds3d::GuardDataRender:

Public Types

using abiRefType = abiRefT< abiDataRender >
 
using abiRefType = abiRefT< abiDataRender >
 
using abiRefType = abiRefT< abiDataRender >
 
using abiRefType = abiRefT< abiDataRender >
 

Public Member Functions

template<typename... Args>
 GuardDataRender (Args &&... args)
 
 ~GuardDataRender ()=default
 
ErrCode preroll (GuardDataMap datamap)
 
ErrCode render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)
 
GuardWindow getWindow () const
 
template<typename... Args>
 GuardDataRender (Args &&... args)
 
 ~GuardDataRender ()=default
 
ErrCode preroll (GuardDataMap datamap)
 
ErrCode render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)
 
GuardWindow getWindow () const
 
template<typename... Args>
 GuardDataRender (Args &&... args)
 
 ~GuardDataRender ()=default
 
ErrCode preroll (GuardDataMap datamap)
 
ErrCode render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)
 
GuardWindow getWindow () const
 
template<typename... Args>
 GuardDataRender (Args &&... args)
 
 ~GuardDataRender ()=default
 
ErrCode preroll (GuardDataMap datamap)
 
ErrCode render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)
 
GuardWindow getWindow () const
 
void setUserData (void *data, DelF delF)
 
void setUserData (void *data, DelF delF)
 
void setUserData (void *data, DelF delF)
 
void setUserData (void *data, DelF delF)
 
virtual void * getUserData () const
 
virtual void * getUserData () const
 
virtual void * getUserData () const
 
virtual void * getUserData () const
 
void setErrorCallback (abiErrorCB::CppFunc errCb)
 
void setErrorCallback (abiErrorCB::CppFunc errCb)
 
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 start (const std::string &content, const std::string &path="")
 
ErrCode start (const std::string &content, const std::string &path="")
 
ErrCode flush ()
 
ErrCode flush ()
 
ErrCode flush ()
 
ErrCode flush ()
 
ErrCode stop ()
 
ErrCode stop ()
 
ErrCode stop ()
 
ErrCode stop ()
 
State state () const
 
State state () const
 
State state () const
 
State state () const
 
std::string getCaps (CapsPort port)
 
std::string getCaps (CapsPort port)
 
std::string getCaps (CapsPort port)
 
std::string getCaps (CapsPort port)
 
std::string getOutputCaps ()
 
std::string getOutputCaps ()
 
std::string getOutputCaps ()
 
std::string getOutputCaps ()
 
std::string getInputCaps ()
 
std::string getInputCaps ()
 
std::string getInputCaps ()
 
std::string getInputCaps ()
 
GuardTy cast ()
 
GuardTy cast ()
 
GuardTy cast ()
 
GuardTy cast ()
 
abiDataRender * ptr () const
 
abiDataRender * ptr () const
 
abiDataRender * ptr () const
 
abiDataRender * ptr () const
 
abiDataRender * operator-> () const
 
abiDataRender * operator-> () const
 
abiDataRender * operator-> () const
 
abiDataRender * operator-> () const
 
 operator bool () const
 
 operator bool () const
 
 operator bool () const
 
 operator bool () const
 
 operator ShrdPtr< abiDataRender > ()
 
 operator ShrdPtr< abiDataRender > ()
 
 operator ShrdPtr< abiDataRender > ()
 
 operator ShrdPtr< abiDataRender > ()
 
abiRefT< abiDataRender > * release ()
 
abiRefT< abiDataRender > * release ()
 
abiRefT< abiDataRender > * release ()
 
abiRefT< abiDataRender > * release ()
 
void reset (abiRefT< abiDataRender > *abiref=nullptr)
 
void reset (abiRefT< abiDataRender > *abiref=nullptr)
 
void reset (abiRefT< abiDataRender > *abiref=nullptr)
 
void reset (abiRefT< abiDataRender > *abiref=nullptr)
 
abiRefT< abiDataRender > * abiRef () const
 
abiRefT< abiDataRender > * abiRef () const
 
abiRefT< abiDataRender > * abiRef () const
 
abiRefT< abiDataRender > * abiRef () const
 

Member Typedef Documentation

◆ abiRefType [1/4]

◆ abiRefType [2/4]

◆ abiRefType [3/4]

◆ abiRefType [4/4]

Constructor & Destructor Documentation

◆ GuardDataRender() [1/4]

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

Definition at line 62 of file includes/ds3d/common/hpp/datarender.hpp.

◆ ~GuardDataRender() [1/4]

ds3d::GuardDataRender::~GuardDataRender ( )
default

◆ GuardDataRender() [2/4]

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

Definition at line 62 of file sources/libs/ds3d/common/hpp/datarender.hpp.

◆ ~GuardDataRender() [2/4]

ds3d::GuardDataRender::~GuardDataRender ( )
default

◆ GuardDataRender() [3/4]

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

Definition at line 62 of file 9.2/includes/ds3d/common/hpp/datarender.hpp.

◆ ~GuardDataRender() [3/4]

ds3d::GuardDataRender::~GuardDataRender ( )
default

◆ GuardDataRender() [4/4]

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

◆ ~GuardDataRender() [4/4]

ds3d::GuardDataRender::~GuardDataRender ( )
default

Member Function Documentation

◆ abiRef() [1/4]

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

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

◆ abiRef() [2/4]

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

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

◆ abiRef() [3/4]

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

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

◆ abiRef() [4/4]

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

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

◆ cast() [1/4]

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

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

◆ cast() [2/4]

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

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

◆ cast() [3/4]

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

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

◆ cast() [4/4]

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

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

◆ flush() [1/4]

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

◆ flush() [2/4]

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

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

◆ flush() [3/4]

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

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

◆ flush() [4/4]

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

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

◆ getCaps() [1/4]

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

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

◆ getCaps() [2/4]

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

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

◆ getCaps() [3/4]

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

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

◆ getCaps() [4/4]

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

◆ getInputCaps() [1/4]

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

◆ getInputCaps() [2/4]

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

◆ getInputCaps() [3/4]

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

◆ getInputCaps() [4/4]

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

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

◆ getOutputCaps() [1/4]

std::string ds3d::GuardDataProcess< abiDataRender , >::getOutputCaps
inlineinherited

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

◆ getOutputCaps() [2/4]

std::string ds3d::GuardDataProcess< abiDataRender , >::getOutputCaps
inlineinherited

◆ getOutputCaps() [3/4]

std::string ds3d::GuardDataProcess< abiDataRender , >::getOutputCaps
inlineinherited

◆ getOutputCaps() [4/4]

std::string ds3d::GuardDataProcess< abiDataRender , >::getOutputCaps
inlineinherited

◆ getUserData() [1/4]

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

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

◆ getUserData() [2/4]

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

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

◆ getUserData() [3/4]

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

◆ getUserData() [4/4]

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

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

◆ getWindow() [1/4]

GuardWindow ds3d::GuardDataRender::getWindow ( ) const
inline

◆ getWindow() [2/4]

GuardWindow ds3d::GuardDataRender::getWindow ( ) const
inline

◆ getWindow() [3/4]

GuardWindow ds3d::GuardDataRender::getWindow ( ) const
inline

◆ getWindow() [4/4]

GuardWindow ds3d::GuardDataRender::getWindow ( ) const
inline

◆ operator bool() [1/4]

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

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

◆ operator bool() [2/4]

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

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

◆ operator bool() [3/4]

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

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

◆ operator bool() [4/4]

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

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

◆ operator ShrdPtr< abiDataRender >() [1/4]

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

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

◆ operator ShrdPtr< abiDataRender >() [2/4]

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

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

◆ operator ShrdPtr< abiDataRender >() [3/4]

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

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

◆ operator ShrdPtr< abiDataRender >() [4/4]

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

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

◆ operator->() [1/4]

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

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

◆ operator->() [2/4]

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

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

◆ operator->() [3/4]

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

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

◆ operator->() [4/4]

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

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

◆ preroll() [1/4]

◆ preroll() [2/4]

◆ preroll() [3/4]

◆ preroll() [4/4]

◆ ptr() [1/4]

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

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

◆ ptr() [2/4]

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

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

◆ ptr() [3/4]

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

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

◆ ptr() [4/4]

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

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

◆ release() [1/4]

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

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

◆ release() [2/4]

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

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

◆ release() [3/4]

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

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

◆ release() [4/4]

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

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

◆ render() [1/4]

◆ render() [2/4]

◆ render() [3/4]

◆ render() [4/4]

◆ reset() [1/4]

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

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

◆ reset() [2/4]

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

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

◆ reset() [3/4]

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

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

◆ reset() [4/4]

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

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

◆ setErrorCallback() [1/4]

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

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

◆ setErrorCallback() [2/4]

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

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

◆ setErrorCallback() [3/4]

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

◆ setErrorCallback() [4/4]

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

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

◆ setUserData() [1/4]

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

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

◆ setUserData() [2/4]

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

◆ setUserData() [3/4]

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

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

◆ setUserData() [4/4]

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

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

◆ start() [1/4]

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

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

◆ start() [2/4]

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

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

◆ start() [3/4]

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

◆ start() [4/4]

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

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

◆ state() [1/4]

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

◆ state() [2/4]

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

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

◆ state() [3/4]

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

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

◆ state() [4/4]

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

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

◆ stop() [1/4]

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

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

◆ stop() [2/4]

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

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

◆ stop() [3/4]

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

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

◆ stop() [4/4]


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