From f4019872c1134c6fcc1d6993e5746f55c1e79208 Mon Sep 17 00:00:00 2001 From: Nikhil Raj Date: Tue, 8 Mar 2022 20:01:38 +0000 Subject: IVGCVSW-6819 Fix the directory structure and broken link to latest docu Signed-off-by: Nikhil Raj Change-Id: I05b559d15faf92c76ff536719693b361316be4f3 --- ...classarmnn_1_1profiling_1_1_packet_buffer.xhtml | 437 +++++++++++++++++++++ 1 file changed, 437 insertions(+) create mode 100644 22.02/classarmnn_1_1profiling_1_1_packet_buffer.xhtml (limited to '22.02/classarmnn_1_1profiling_1_1_packet_buffer.xhtml') diff --git a/22.02/classarmnn_1_1profiling_1_1_packet_buffer.xhtml b/22.02/classarmnn_1_1profiling_1_1_packet_buffer.xhtml new file mode 100644 index 0000000000..58d938ec40 --- /dev/null +++ b/22.02/classarmnn_1_1profiling_1_1_packet_buffer.xhtml @@ -0,0 +1,437 @@ + + + + + + + + + + + + + +ArmNN: PacketBuffer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  22.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
PacketBuffer Class Reference
+
+
+ +

#include <PacketBuffer.hpp>

+
+Inheritance diagram for PacketBuffer:
+
+
+ + +IPacketBuffer +IReadOnlyPacketBuffer + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 PacketBuffer (unsigned int maxSize)
 
 ~PacketBuffer ()
 
const unsigned char * GetReadableData () const override
 
unsigned int GetSize () const override
 
void MarkRead () override
 
void Commit (unsigned int size) override
 
void Release () override
 
unsigned char * GetWritableData () override
 
void Destroy () override
 release the memory held and reset internal point to null. More...
 
- Public Member Functions inherited from IPacketBuffer
virtual ~IPacketBuffer ()
 
- Public Member Functions inherited from IReadOnlyPacketBuffer
virtual ~IReadOnlyPacketBuffer ()
 
+

Detailed Description

+
+

Definition at line 18 of file PacketBuffer.hpp.

+

Constructor & Destructor Documentation

+ +

◆ PacketBuffer()

+ +
+
+ + + + + + + + +
PacketBuffer (unsigned int maxSize)
+
+ +

Definition at line 16 of file PacketBuffer.cpp.

+
17  : m_MaxSize(maxSize)
18  , m_Size(0)
19 {
20  m_Data = std::make_unique<unsigned char[]>(m_MaxSize);
21 }
+
+
+ +

◆ ~PacketBuffer()

+ +
+
+ + + + + +
+ + + + + + + +
~PacketBuffer ()
+ 		+inline
+
+ +

Definition at line 23 of file PacketBuffer.hpp.

+ +

References PacketBuffer::Commit(), PacketBuffer::Destroy(), PacketBuffer::GetReadableData(), PacketBuffer::GetSize(), PacketBuffer::GetWritableData(), PacketBuffer::MarkRead(), and PacketBuffer::Release().

+
23 {}
+
+
+

Member Function Documentation

+ +

◆ Commit()

+ +
+
+ + + + + +
+ + + + + + + + +
void Commit (unsigned int size)
+ 		+overridevirtual
+
+ +

Implements IPacketBuffer.

+ +

Definition at line 38 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
39 {
40  if (size > m_MaxSize)
41  {
42  throw armnn::RuntimeException("Cannot commit [" + std::to_string(size) +
43  "] bytes which is more than the maximum size of the buffer [" + std::to_string(m_MaxSize) + "]");
44  }
45  m_Size = size;
46 }
+
+
+
+ +

◆ Destroy()

+ +
+
+ + + + + +
+ + + + + + + +
void Destroy ()
+ 		+overridevirtual
+
+ +

release the memory held and reset internal point to null.

+

After this function is invoked the PacketBuffer is unusable.

+ +

Implements IPacketBuffer.

+ +

Definition at line 58 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
59 {
60  m_Data.reset(nullptr);
61  m_Size = 0;
62  m_MaxSize = 0;
63 }
+
+
+ +

◆ GetReadableData()

+ +
+
+ + + + + +
+ + + + + + + +
const unsigned char * GetReadableData () const
+ 		+overridevirtual
+
+ +

Implements IReadOnlyPacketBuffer.

+ +

Definition at line 23 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
24 {
25  return m_Data.get();
26 }
+
+
+ +

◆ GetSize()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned int GetSize () const
+ 		+overridevirtual
+
+ +

Implements IReadOnlyPacketBuffer.

+ +

Definition at line 28 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
29 {
30  return m_Size;
31 }
+
+
+ +

◆ GetWritableData()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned char * GetWritableData ()
+ 		+overridevirtual
+
+ +

Implements IPacketBuffer.

+ +

Definition at line 53 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
54 {
55  return m_Data.get();
56 }
+
+
+ +

◆ MarkRead()

+ +
+
+ + + + + +
+ + + + + + + +
void MarkRead ()
+ 		+overridevirtual
+
+ +

Implements IReadOnlyPacketBuffer.

+ +

Definition at line 33 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
34 {
35  m_Size = 0;
36 }
+
+
+ +

◆ Release()

+ +
+
+ + + + + +
+ + + + + + + +
void Release ()
+ 		+overridevirtual
+
+ +

Implements IPacketBuffer.

+ +

Definition at line 48 of file PacketBuffer.cpp.

+ +

Referenced by PacketBuffer::~PacketBuffer().

+
49 {
50  m_Size = 0;
51 }
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1