NVIDIA NvNeural SDK  2022.2
GPU inference framework for NVIDIA Nsight Deep Learning Designer
nvneural::BackendDeviceIdentifier Class Reference

Standard implementation of IBackendDeviceIdentifier. More...

#include <BackendDeviceIdentifier.h>

Inheritance diagram for nvneural::BackendDeviceIdentifier:
nvneural::refobj::RefObjectBase< refobj::Implements< IBackendDeviceIdentifier > >

Public Member Functions

 BackendDeviceIdentifier (std::uint64_t uuidLow, std::uint64_t uuidHigh, const std::string &deviceName)
 Creates a BackendDeviceIdentifier that reports the provided UUID and device name. More...
 
NeuralResult getDeviceIdentifiers (std::uint64_t *pUuidLow, std::uint64_t *pUuidHigh) const noexcept
 Retrieves a pair of values that uniquely identify this GPU on the local system. More...
 
const char * getDeviceName () const noexcept
 Retrieves the name of this GPU. More...
 
- Public Member Functions inherited from nvneural::refobj::RefObjectBase< refobj::Implements< IBackendDeviceIdentifier > >
IRefObject::RefCount addRef () const noexcept
 Increment the object's reference count. More...
 
const void * queryInterface (IRefObject::TypeId interfaceId) const noexcept
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void * queryInterface (IRefObject::TypeId interfaceId) noexcept
 Retrieves a new object interface pointer. More...
 
 RefObjectBase ()
 Default constructor. Logs object creation.
 
IRefObject::RefCount release () const noexcept
 Decrements the object's reference count and destroys the object if the reference count reaches zero. More...
 

Detailed Description

Standard implementation of IBackendDeviceIdentifier.

Constructor & Destructor Documentation

◆ BackendDeviceIdentifier()

BackendDeviceIdentifier::BackendDeviceIdentifier ( std::uint64_t  uuidLow,
std::uint64_t  uuidHigh,
const std::string &  deviceName 
)

Creates a BackendDeviceIdentifier that reports the provided UUID and device name.

Parameters
uuidLowLower 64 bits of the device UUID
uuidHighUpper 64 bits of the device UUID
deviceNameHuman-readable name of the device

Member Function Documentation

◆ getDeviceIdentifiers()

NeuralResult BackendDeviceIdentifier::getDeviceIdentifiers ( std::uint64_t *  pUuidLow,
std::uint64_t *  pUuidHigh 
) const
noexcept

Retrieves a pair of values that uniquely identify this GPU on the local system.

Parameters
pUuidLowPointer to a variable receiving the lower 64 bits of the device identifier
pUuidHighPointer to a variable receiving the upper 64 bits of the device identifier

◆ getDeviceName()

const char * BackendDeviceIdentifier::getDeviceName ( ) const
noexcept

Retrieves the name of this GPU.

The pointer returned is valid for the lifespan of this object.

Returns
Pointer to a null-terminated UTF-8 string describing this GPU.

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