From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/_profiling_event_8hpp_source.xhtml | 132 +++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 21.02/_profiling_event_8hpp_source.xhtml (limited to '21.02/_profiling_event_8hpp_source.xhtml') diff --git a/21.02/_profiling_event_8hpp_source.xhtml b/21.02/_profiling_event_8hpp_source.xhtml new file mode 100644 index 0000000000..754661be5d --- /dev/null +++ b/21.02/_profiling_event_8hpp_source.xhtml @@ -0,0 +1,132 @@ + + + + + + + + + + + + + +ArmNN: src/armnn/ProfilingEvent.hpp Source File + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
ProfilingEvent.hpp
+
+
+Go to the documentation of this file.
1 //
2 // Copyright © 2017 Arm Ltd. All rights reserved.
3 // SPDX-License-Identifier: MIT
4 //
5 
6 #pragma once
7 
8 #include <stack>
9 #include <vector>
10 #include <chrono>
11 #include <memory>
12 #include "Instrument.hpp"
13 #include "armnn/Types.hpp"
14 
15 namespace armnn
16 {
17 
18 /// Forward declaration
19 class IProfiler;
20 
21 /// Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when
22 /// Event::GetMeasurements() is called.
23 class Event
24 {
25 public:
26  using InstrumentPtr = std::unique_ptr<Instrument>;
27  using Instruments = std::vector<InstrumentPtr>;
28 
29  Event(const std::string& eventName,
30  IProfiler* profiler,
31  Event* parent,
32  const BackendId backendId,
33  std::vector<InstrumentPtr>&& instrument);
34 
35  Event(const Event& other) = delete;
36 
37  /// Move Constructor
38  Event(Event&& other) noexcept;
39 
40  /// Destructor
41  ~Event() noexcept;
42 
43  /// Start the Event
44  void Start();
45 
46  /// Stop the Event
47  void Stop();
48 
49  /// Get the recorded measurements calculated between Start() and Stop()
50  /// \return Recorded measurements of the event
51  const std::vector<Measurement> GetMeasurements() const;
52 
53  /// Get the name of the event
54  /// \return Name of the event
55  const std::string& GetName() const;
56 
57  /// Get the pointer of the profiler associated with this event
58  /// \return Pointer of the profiler associated with this event
59  const IProfiler* GetProfiler() const;
60 
61  /// Get the pointer of the parent event
62  /// \return Pointer of the parent event
63  const Event* GetParentEvent() const;
64 
65  /// Get the backend id of the event
66  /// \return Backend id of the event
67  BackendId GetBackendId() const;
68 
69  /// Assignment operator
70  Event& operator=(const Event& other) = delete;
71 
72  /// Move Assignment operator
73  Event& operator=(Event&& other) noexcept;
74 
75 private:
76  /// Name of the event
77  std::string m_EventName;
78 
79  /// Stored associated profiler
80  IProfiler* m_Profiler;
81 
82  /// Stores optional parent event
83  Event* m_Parent;
84 
85  /// Backend id
86  BackendId m_BackendId;
87 
88  /// Instruments to use
89  Instruments m_Instruments;
90 };
91 
92 } // namespace armnn
armnn::Event
Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...
Definition: ProfilingEvent.hpp:23
+
armnn::Event::~Event
~Event() noexcept
Destructor.
Definition: ProfilingEvent.cpp:34
+
armnn::Event::Instruments
std::vector< InstrumentPtr > Instruments
Definition: ProfilingEvent.hpp:27
+ +
armnn::Event::GetName
const std::string & GetName() const
Get the name of the event.
Definition: ProfilingEvent.cpp:67
+
armnn
Copyright (c) 2021 ARM Limited and Contributors.
Definition: 01_00_software_tools.dox:6
+
armnn::Event::Start
void Start()
Start the Event.
Definition: ProfilingEvent.cpp:38
+
armnn::Event::Stop
void Stop()
Stop the Event.
Definition: ProfilingEvent.cpp:46
+
armnn::Event::GetBackendId
BackendId GetBackendId() const
Get the backend id of the event.
Definition: ProfilingEvent.cpp:82
+ +
armnn::Event::GetMeasurements
const std::vector< Measurement > GetMeasurements() const
Get the recorded measurements calculated between Start() and Stop()
Definition: ProfilingEvent.cpp:54
+
armnn::Event::InstrumentPtr
std::unique_ptr< Instrument > InstrumentPtr
Definition: ProfilingEvent.hpp:26
+
Types.hpp
+
armnn::Event::GetProfiler
const IProfiler * GetProfiler() const
Get the pointer of the profiler associated with this event.
Definition: ProfilingEvent.cpp:72
+ +
armnn::Event::GetParentEvent
const Event * GetParentEvent() const
Get the pointer of the parent event.
Definition: ProfilingEvent.cpp:77
+
armnn::Event::Event
Event(const std::string &eventName, IProfiler *profiler, Event *parent, const BackendId backendId, std::vector< InstrumentPtr > &&instrument)
Definition: ProfilingEvent.cpp:11
+
Instrument.hpp
+ +
+
+ + + + -- cgit v1.2.1