IStatusMessageLayer is an optional interface intended for ILayer to provide status messages. More...
#include <nvneural/LayerTypes.h>
Public Member Functions | |
| virtual NeuralResult | copyStatusMessage (char *pBuffer, std::size_t bufferSize) noexcept=0 |
| Copy the status message to the pre-allocated buffer. More... | |
| virtual std::size_t | nextStatusMessageSize () const noexcept=0 |
| Returns the size of the next status message including trailing null. 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 = 0x945791d0e3af06fcul |
| 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
IStatusMessageLayer is an optional interface intended for ILayer to provide status messages.
These messages appear in the network view of DL Designer during inference.
Member Function Documentation
◆ copyStatusMessage()
|
pure virtualnoexcept |
Copy the status message to the pre-allocated buffer.
The implementer of copyStatusMessage should null-terminate the returned string. This method should also perform buffer checks and truncate (but still null-terminate!) if bufferSize is too small.
- Parameters
-
pBuffer The pre-allocated buffer which will contain the status message bufferSize The size of the allocated buffer pBuffer
◆ nextStatusMessageSize()
|
pure virtualnoexcept |
Returns the size of the next status message including trailing null.
The next status message represents the status message that would be broadcasted during the next call to copyStatusMessage. If no message is available, the returned size needs to be 0.
The documentation for this class was generated from the following file:
- Core/Inc/nvneural/LayerTypes.h
