nvneural::IPrototypePlugin Class Reference

IPrototypePlugin is an optional interface implemented by IPlugin objects that describes generic prototype layers implemented inside the plugin. More...

#include <nvneural/PluginTypes.h>

Inheritance diagram for nvneural::IPrototypePlugin:

Public Member Functions
virtual const PrototypeDesc *	getPrototypeDesc (std::size_t prototypeIndex) const noexcept=0
	Returns a pointer to an PrototypeDesc object by index. More...
virtual std::size_t	getPrototypeDescCount () const noexcept=0
	Returns the number of PrototypeDesc objects accessible through this interface. More...
virtual PrototypeRuntimeValidatorFunction	getPrototypeRuntimeValidator (std::size_t prototypeIndex) const noexcept=0
	Returns a PrototypeRuntimeValidatorFunction function by index. More...
Public Member Functions inherited from nvneural::IRefObject
virtual RefCount	addRef () const noexcept=0
	Increments the object's reference count. More...
virtual const void *	queryInterface (TypeId interface) const noexcept=0
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual void *	queryInterface (TypeId interface) noexcept=0
	Retrieves a new object interface pointer. More...
virtual RefCount	release () const noexcept=0
	Decrements the object's reference count and destroy the object if the reference count reaches zero. More...

Static Public Attributes
static const IRefObject::TypeId	typeID = 0x55309c8928361be1ul
	Interface TypeId for InterfaceOf purposes.
Static Public Attributes inherited from nvneural::IRefObject
static const TypeId	typeID = 0x14ecc3f9de638e1dul
	Interface TypeId for InterfaceOf purposes.

Additional Inherited Members
Public Types inherited from nvneural::IRefObject
using	RefCount = std::uint32_t
	Typedef used to track the number of active references to an object.
using	TypeId = std::uint64_t
	Every interface must define a unique TypeId. This should be randomized.
Protected Member Functions inherited from nvneural::IRefObject
virtual	~IRefObject ()=default
	A protected destructor prevents accidental stack-allocation of IRefObjects or use with other smart pointer classes like std::unique_ptr.

Detailed Description

IPrototypePlugin is an optional interface implemented by IPlugin objects that describes generic prototype layers implemented inside the plugin.

Member Function Documentation

getPrototypeDesc()

virtual const PrototypeDesc* nvneural::IPrototypePlugin::getPrototypeDesc ( std::size_t  prototypeIndex ) const

pure virtualnoexcept

Returns a pointer to an PrototypeDesc object by index.

Parameters

prototypeIndex

Index to retrieve; must be less than the value of getPrototypeDesc

Returns

A pointer to PrototypeDesc that will remain valid through the lifespan of this object, or nullptr if prototypeIndex is out of bounds.

getPrototypeDescCount()

virtual std::size_t nvneural::IPrototypePlugin::getPrototypeDescCount ( ) const

pure virtualnoexcept

Returns the number of PrototypeDesc objects accessible through this interface.

The value returned by this function must remain constant throughout the lifespan of this plugin object.

getPrototypeRuntimeValidator()

virtual PrototypeRuntimeValidatorFunction nvneural::IPrototypePlugin::getPrototypeRuntimeValidator ( std::size_t  prototypeIndex ) const

pure virtualnoexcept

Returns a PrototypeRuntimeValidatorFunction function by index.

Parameters

prototypeIndex

Index to retrieve; must be less than the value of getPrototypeDesc

Returns

A function pointer of PrototypeRuntimeValidatorFunction that will remain valid through the lifespan of this object, or nullptr if prototypeIndex is out of bounds.

---

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

• Core/Inc/nvneural/PluginTypes.h