Detailed Description

Represent a custom object for the purpose of probing output buffers.

Appropriate interface must be implemented and assigned to an BufferProbe instance for it to work.

BufferProbe instances are not copyable/movable.

Definition at line 58 of file buffer_probe.hpp.

Inheritance diagram for deepstream::BufferProbe:

[legend]

Collaboration diagram for deepstream::BufferProbe:

[legend]

Data Structures
class	IBatchMetadataObserver
	Readonly interface for handling batch metadata. More...

class	IBatchMetadataOperator
	Read/write interface for handling batch metadata. More...

class	IBufferHandler
	Derived interface for handling buffer itself. More...

class	IBufferObserver
	Readonly interface for handling buffer. More...

class	IBufferOperator
	Read/write interface for handling buffer. More...

class	IHandler
	Root interface required by a BufferProbe instance. More...

class	IMetadataHandler
	Derived interface for handling metadata. More...

Public Member Functions
	BufferProbe (const std::string &name, IHandler *handler)
	Constructor. More...

	BufferProbe (const std::string &name, const char factory, IHandler handler)
	Constructor for factory. More...

virtual	~BufferProbe ()
	Destructor. More...

BufferProbe &	attach (Element *target, Pad pad)
	Attach the BufferProbe instance to an Element instance. More...

Element *	getTarget ()
	Return the pointer to the element where the probe is attached. More...

const Pad &	getPad ()
	Return the pad from which the probe takes buffers. More...

template<typename T >
bool	query (T *&interface) const
	Template class to query the type of the handler inteface. More...

const std::string	getName () const
	Return the name assigned during the construction. More...

	operator bool () const noexcept
	Check if the object is void. More...

bool	operator== (const Object &other) noexcept
	Check if the two objects are the same. More...

GstObject *	give ()
	Give up the ownership and return the opaque pointer. More...

GstObject *	getGObject ()
	Return the opaque object pointer. More...

Object &	take (GstObject *object)
	Takes the ownership of a object through the opaque pointer. More...

Object &	seize (GstObject *object)
	Seize a opaque object to prevent it from being destroyed somewhere. More...

Object &	set (const YAML::Node &params)
	Set the properties from key/value pairs in the yaml format. More...

Object &	set (const std::string &name, const Value &value)

template<typename T , typename... Args>
Object &	set (const std::string &name, const T &value, const Args &... args)

template<typename T , typename... Args>
Object &	getProperty (const std::string &name, T &value, Args &... args)
	Template for getting multiple properties. More...

std::vector< std::string >	listSignals (bool is_action)
	List all the supported signals from the object. More...

bool	connectSignal (const std::string &signal_name, SignalHandler &handler)
	Connect a signal handler to the object. More...

void	emitSignal (const std::string &signal_name, va_list args)
	Emit a signal. More...

Static Public Member Functions
static unsigned long	type ()
	Get the unique id associated with this type of BufferProbe. More...

Protected Member Functions
virtual void	set_ (const std::string &name, const Value &value)

virtual void	set_ (const std::string &name, const YAML::Node &value)

virtual Value	get_ (const std::string &name)

Protected Attributes
std::unique_ptr< IHandler >	metadata_handler_
	Buffer probe takes the ownership of the handler instance assigned to it during construction. More...

Pad	pad_
	the Pad from which the probe takes buffers, More...

Element *	target_
	weak reference to the target element to which it is attached, More...

std::string	param_spec_
	property spec in YAML format More...

std::map< std::string, Object::Value >	properties_
	property map More...

GstObject *	object_

Constructor & Destructor Documentation

◆ BufferProbe() [1/2]

deepstream::BufferProbe::BufferProbe	(	const std::string &	name,
		IHandler *	handler
	)

Constructor.

Create a BufferProbe instance with user implemented handler interface

Parameters

[in]	name	name of the instance
[in]	handler	implementation of the IHandler interface

◆ BufferProbe() [2/2]

deepstream::BufferProbe::BufferProbe	(	const std::string &	name,
		const char *	factory,
		IHandler *	handler
	)

Constructor for factory.

Create a BufferProbe instance with user implemented handler interface

Parameters

[in]	name	name of the instance
[in]	handler	implementation of the IHandler interface

◆ ~BufferProbe()

virtual deepstream::BufferProbe::~BufferProbe ( )

virtual

Destructor.

Member Function Documentation

◆ attach()

BufferProbe& deepstream::BufferProbe::attach	(	Element *	target,
		Pad	pad
	)

Attach the BufferProbe instance to an Element instance.

The probe must be attached to the output.

Parameters

[in]	target	pointer to the Element instance
[in]	pad	target pad from which the probe takes buffers

◆ connectSignal()

bool deepstream::Object::connectSignal	(	const std::string &	signal_name,
		SignalHandler &	handler
	)

inherited

Connect a signal handler to the object.

Parameters

[in]	signal_name	name of the signal to be connected
[in]	handler	handler for the signal

◆ emitSignal()

void deepstream::Object::emitSignal	(	const std::string &	signal_name,
		va_list	args
	)

inherited

Emit a signal.

◆ get_()

virtual Value deepstream::CustomObject::get_ ( const std::string & name )

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ getGObject()

GstObject* deepstream::Object::getGObject ( )

inlineinherited

Return the opaque object pointer.

Definition at line 140 of file object.hpp.

References deepstream::Object::object_.

◆ getName()

const std::string deepstream::Object::getName ( ) const

inherited

Return the name assigned during the construction.

◆ getPad()

const Pad& deepstream::BufferProbe::getPad ( )

inline

Return the pad from which the probe takes buffers.

Definition at line 169 of file buffer_probe.hpp.

References pad_.

◆ getProperty()

template<typename T , typename... Args>

Object& deepstream::Object::getProperty	(	const std::string &	name,
		T &	value,
		Args &...	args
	)

inlineinherited

Template for getting multiple properties.

Definition at line 171 of file object.hpp.

References deepstream::Object::get_().

Referenced by deepstream::CountMarker::handleData(), deepstream::TensorMetaParser::handleData(), deepstream::MsgMetaGenerator::handleData(), deepstream::NvDsKittiDump::handleData(), deepstream::LiDARDataSource::initialize(), deepstream::SmartRecordingAction::onAttached(), and deepstream::FileDataSource::read().

◆ getTarget()

Element* deepstream::BufferProbe::getTarget ( )

inline

Return the pointer to the element where the probe is attached.

Definition at line 163 of file buffer_probe.hpp.

References target_.

◆ give()

GstObject* deepstream::Object::give ( )

inherited

Give up the ownership and return the opaque pointer.

◆ listSignals()

std::vector<std::string> deepstream::Object::listSignals ( bool is_action )

inherited

List all the supported signals from the object.

◆ operator bool()

deepstream::Object::operator bool ( ) const

inlineexplicitnoexceptinherited

Check if the object is void.

Definition at line 131 of file object.hpp.

References deepstream::Object::object_.

◆ operator==()

bool deepstream::Object::operator== ( const Object & other )

inlinenoexceptinherited

Check if the two objects are the same.

Definition at line 134 of file object.hpp.

References deepstream::Object::object_.

◆ query()

template<typename T >

bool deepstream::BufferProbe::query ( T *& interface ) const

inline

Template class to query the type of the handler inteface.

Definition at line 176 of file buffer_probe.hpp.

References metadata_handler_.

◆ seize()

Object& deepstream::Object::seize ( GstObject * object )

inherited

Seize a opaque object to prevent it from being destroyed somewhere.

◆ set() [1/3]

template<typename T , typename... Args>

Object& deepstream::Object::set	(	const std::string &	name,
		const T &	value,
		const Args &...	args
	)

inlineinherited

Definition at line 161 of file object.hpp.

References deepstream::Object::set(), and deepstream::Object::set_().

◆ set() [2/3]

Object& deepstream::Object::set	(	const std::string &	name,
		const Value &	value
	)

inlineinherited

Definition at line 154 of file object.hpp.

References deepstream::Object::set_().

◆ set() [3/3]

Object& deepstream::Object::set ( const YAML::Node & params )

inherited

Set the properties from key/value pairs in the yaml format.

Referenced by deepstream::Pipeline::add(), and deepstream::Object::set().

◆ set_() [1/2]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const Value &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ set_() [2/2]

virtual void deepstream::CustomObject::set_	(	const std::string &	name,
		const YAML::Node &	value
	)

protectedvirtualinherited

Reimplemented from deepstream::Object.

◆ take()

Object& deepstream::Object::take ( GstObject * object )

inherited

Takes the ownership of a object through the opaque pointer.

◆ type()

static unsigned long deepstream::BufferProbe::type ( )

static

Get the unique id associated with this type of BufferProbe.

An unique number is assigned for each BufferProbe class defined within a custom plugin.

Field Documentation

◆ metadata_handler_

std::unique_ptr<IHandler> deepstream::BufferProbe::metadata_handler_

protected

Buffer probe takes the ownership of the handler instance assigned to it during construction.

Definition at line 187 of file buffer_probe.hpp.

Referenced by query().

◆ object_

GstObject* deepstream::Object::object_

protectedinherited

Definition at line 198 of file object.hpp.

Referenced by deepstream::Object::getGObject(), deepstream::Object::operator bool(), and deepstream::Object::operator==().

◆ pad_

Pad deepstream::BufferProbe::pad_

protected

the Pad from which the probe takes buffers,

See also: Pad

Definition at line 189 of file buffer_probe.hpp.

Referenced by getPad().

◆ param_spec_

std::string deepstream::CustomObject::param_spec_

protectedinherited

property spec in YAML format

Definition at line 51 of file custom_object.hpp.

◆ properties_

std::map<std::string, Object::Value> deepstream::CustomObject::properties_

protectedinherited

property map

Definition at line 53 of file custom_object.hpp.

◆ target_

Element* deepstream::BufferProbe::target_

protected

weak reference to the target element to which it is attached,

See also: Element

Definition at line 194 of file buffer_probe.hpp.

Referenced by getTarget().

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

buffer_probe.hpp


NVIDIA DeepStream SDK API Reference	8.0 Release

NVIDIA DeepStream SDK API Reference

8.0 Release

Detailed Description

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BufferProbe() [1/2]

◆ BufferProbe() [2/2]

◆ ~BufferProbe()

Member Function Documentation

◆ attach()

◆ connectSignal()

◆ emitSignal()

◆ get_()

◆ getGObject()

◆ getName()

◆ getPad()

◆ getProperty()

◆ getTarget()

◆ give()

◆ listSignals()

◆ operator bool()

◆ operator==()

◆ query()

◆ seize()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ set_() [1/2]

◆ set_() [2/2]

◆ take()

◆ type()

Field Documentation

◆ metadata_handler_

◆ object_

◆ pad_

◆ param_spec_

◆ properties_

◆ target_