NVIDIA DeepStream SDK API Reference: nvdsinferserver::IOptions Class Reference | NVIDIA Docs


NVIDIA DeepStream SDK API Reference	8.0 Release

Detailed Description

Definition at line 54 of file sources/includes/nvdsinferserver/infer_ioptions.h.

Inheritance diagram for nvdsinferserver::IOptions:

Inheritance graph

[legend]

Data Structures
struct	oType

struct	oType< bool >

struct	oType< double >

struct	oType< int64_t >

struct	oType< std::string >

struct	oType< uint64_t >

struct	oType< Value * >

struct	OTypeV

Public Member Functions
	IOptions ()=default

virtual	~IOptions ()=default

virtual bool	hasValue (const std::string &key) const =0

virtual OptionType	getType (const std::string &name) const =0

virtual uint32_t	getCount () const =0

virtual std::string	getKey (uint32_t idx) const =0

NvDsInferStatus	getDouble (const std::string &name, double &v) const

NvDsInferStatus	getInt (const std::string &name, int64_t &v) const

NvDsInferStatus	getUInt (const std::string &name, uint64_t &v) const

NvDsInferStatus	getString (const std::string &name, std::string &v)

NvDsInferStatus	getBool (const std::string &name, bool &v) const

template<typename Obj >
NvDsInferStatus	getObj (const std::string &name, Obj *&obj) const

template<typename Value >
NvDsInferStatus	getValue (const std::string &name, Value &value) const

template<typename Value >
NvDsInferStatus	getValueArray (const std::string &name, std::vector< Value > &values) const

	IOptions ()=default

virtual	~IOptions ()=default

virtual bool	hasValue (const std::string &key) const =0

virtual OptionType	getType (const std::string &name) const =0

virtual uint32_t	getCount () const =0

virtual std::string	getKey (uint32_t idx) const =0

NvDsInferStatus	getDouble (const std::string &name, double &v) const

NvDsInferStatus	getInt (const std::string &name, int64_t &v) const

NvDsInferStatus	getUInt (const std::string &name, uint64_t &v) const

NvDsInferStatus	getString (const std::string &name, std::string &v)

NvDsInferStatus	getBool (const std::string &name, bool &v) const

template<typename Obj >
NvDsInferStatus	getObj (const std::string &name, Obj *&obj) const

template<typename Value >
NvDsInferStatus	getValue (const std::string &name, Value &value) const

template<typename Value >
NvDsInferStatus	getValueArray (const std::string &name, std::vector< Value > &values) const

Protected Member Functions
virtual NvDsInferStatus	getValuePtr (const std::string &name, OptionType t, void *&ptr) const =0

virtual NvDsInferStatus	getArraySize (const std::string &key, uint32_t &size) const =0

virtual NvDsInferStatus	getRawPtrArray (const std::string &name, OptionType ot, void **ptrBase, uint32_t size) const =0

virtual NvDsInferStatus	getValuePtr (const std::string &name, OptionType t, void *&ptr) const =0

virtual NvDsInferStatus	getArraySize (const std::string &key, uint32_t &size) const =0

virtual NvDsInferStatus	getRawPtrArray (const std::string &name, OptionType ot, void **ptrBase, uint32_t size) const =0

Constructor & Destructor Documentation

◆ IOptions() [1/2]

nvdsinferserver::IOptions::IOptions ( )

default

◆ ~IOptions() [1/2]

virtual nvdsinferserver::IOptions::~IOptions ( )

virtualdefault

◆ IOptions() [2/2]

nvdsinferserver::IOptions::IOptions ( )

default

◆ ~IOptions() [2/2]

virtual nvdsinferserver::IOptions::~IOptions ( )

virtualdefault

Member Function Documentation

◆ getArraySize() [1/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getArraySize	(	const std::string &	key,
		uint32_t &	size
	)		const

protectedpure virtual

Referenced by getValueArray().

◆ getArraySize() [2/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getArraySize	(	const std::string &	key,
		uint32_t &	size
	)		const

protectedpure virtual

◆ getBool() [1/2]

NvDsInferStatus nvdsinferserver::IOptions::getBool	(	const std::string &	name,
		bool &	v
	)		const

inline

Definition at line 94 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getBool() [2/2]

NvDsInferStatus nvdsinferserver::IOptions::getBool	(	const std::string &	name,
		bool &	v
	)		const

inline

Definition at line 94 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getCount() [1/2]

virtual uint32_t nvdsinferserver::IOptions::getCount ( ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getCount() [2/2]

virtual uint32_t nvdsinferserver::IOptions::getCount ( ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getDouble() [1/2]

NvDsInferStatus nvdsinferserver::IOptions::getDouble	(	const std::string &	name,
		double &	v
	)		const

inline

Definition at line 78 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getDouble() [2/2]

NvDsInferStatus nvdsinferserver::IOptions::getDouble	(	const std::string &	name,
		double &	v
	)		const

inline

Definition at line 78 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getInt() [1/2]

NvDsInferStatus nvdsinferserver::IOptions::getInt	(	const std::string &	name,
		int64_t &	v
	)		const

inline

Definition at line 82 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getInt() [2/2]

NvDsInferStatus nvdsinferserver::IOptions::getInt	(	const std::string &	name,
		int64_t &	v
	)		const

inline

Definition at line 82 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getKey() [1/2]

virtual std::string nvdsinferserver::IOptions::getKey ( uint32_t idx ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getKey() [2/2]

virtual std::string nvdsinferserver::IOptions::getKey ( uint32_t idx ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getObj() [1/2]

template<typename Obj >

NvDsInferStatus nvdsinferserver::IOptions::getObj	(	const std::string &	name,
		Obj *&	obj
	)		const

inline

Definition at line 99 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getObj() [2/2]

template<typename Obj >

NvDsInferStatus nvdsinferserver::IOptions::getObj	(	const std::string &	name,
		Obj *&	obj
	)		const

inline

Definition at line 99 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getRawPtrArray() [1/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getRawPtrArray	(	const std::string &	name,
		OptionType	ot,
		void **	ptrBase,
		uint32_t	size
	)		const

protectedpure virtual

◆ getRawPtrArray() [2/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getRawPtrArray	(	const std::string &	name,
		OptionType	ot,
		void **	ptrBase,
		uint32_t	size
	)		const

protectedpure virtual

Referenced by getValueArray().

◆ getString() [1/2]

NvDsInferStatus nvdsinferserver::IOptions::getString	(	const std::string &	name,
		std::string &	v
	)

inline

Definition at line 90 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getString() [2/2]

NvDsInferStatus nvdsinferserver::IOptions::getString	(	const std::string &	name,
		std::string &	v
	)

inline

Definition at line 90 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getType() [1/2]

virtual OptionType nvdsinferserver::IOptions::getType ( const std::string & name ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getType() [2/2]

virtual OptionType nvdsinferserver::IOptions::getType ( const std::string & name ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ getUInt() [1/2]

NvDsInferStatus nvdsinferserver::IOptions::getUInt	(	const std::string &	name,
		uint64_t &	v
	)		const

inline

Definition at line 86 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getUInt() [2/2]

NvDsInferStatus nvdsinferserver::IOptions::getUInt	(	const std::string &	name,
		uint64_t &	v
	)		const

inline

Definition at line 86 of file sources/includes/nvdsinferserver/infer_ioptions.h.

◆ getValue() [1/2]

template<typename Value >

NvDsInferStatus nvdsinferserver::IOptions::getValue	(	const std::string &	name,
		Value &	value
	)		const

inline

Definition at line 105 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

References getValuePtr(), and NVDSINFER_SUCCESS.

◆ getValue() [2/2]

template<typename Value >

NvDsInferStatus nvdsinferserver::IOptions::getValue	(	const std::string &	name,
		Value &	value
	)		const

inline

Definition at line 105 of file sources/includes/nvdsinferserver/infer_ioptions.h.

References getValuePtr(), and NVDSINFER_SUCCESS.

◆ getValueArray() [1/2]

template<typename Value >

NvDsInferStatus nvdsinferserver::IOptions::getValueArray	(	const std::string &	name,
		std::vector< Value > &	values
	)		const

inline

Definition at line 119 of file sources/includes/nvdsinferserver/infer_ioptions.h.

References getArraySize(), getRawPtrArray(), and NVDSINFER_SUCCESS.

◆ getValueArray() [2/2]

template<typename Value >

NvDsInferStatus nvdsinferserver::IOptions::getValueArray	(	const std::string &	name,
		std::vector< Value > &	values
	)		const

inline

Definition at line 119 of file 9.0/sources/includes/nvdsinferserver/infer_ioptions.h.

References getArraySize(), getRawPtrArray(), and NVDSINFER_SUCCESS.

◆ getValuePtr() [1/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getValuePtr	(	const std::string &	name,
		OptionType	t,
		void *&	ptr
	)		const

protectedpure virtual

Referenced by getValue().

◆ getValuePtr() [2/2]

virtual NvDsInferStatus nvdsinferserver::IOptions::getValuePtr	(	const std::string &	name,
		OptionType	t,
		void *&	ptr
	)		const

protectedpure virtual

◆ hasValue() [1/2]

virtual bool nvdsinferserver::IOptions::hasValue ( const std::string & key ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

◆ hasValue() [2/2]

virtual bool nvdsinferserver::IOptions::hasValue ( const std::string & key ) const

pure virtual

Implemented in nvdsinferserver::BufOptions, and nvdsinferserver::BufOptions.

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

sources/includes/nvdsinferserver/infer_ioptions.h

Privacy Policy | Manage My Privacy | Do Not Sell or Share My Data | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact
© 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
NVIDIA Confidential | Subject to Change | For test and development only.
Tue Mar 17 2026 09:31:11 | PR-09318-R32