From 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 Mon Sep 17 00:00:00 2001 From: Jim Flynn Date: Thu, 19 Mar 2020 17:03:14 +0000 Subject: Creating gh-pages documentation for ArmNN Signed-off-by: Jim Flynn --- Documentation/class_i_timeline_decoder.xhtml | 421 +++++++++++++++++++++++++++ 1 file changed, 421 insertions(+) create mode 100644 Documentation/class_i_timeline_decoder.xhtml (limited to 'Documentation/class_i_timeline_decoder.xhtml') diff --git a/Documentation/class_i_timeline_decoder.xhtml b/Documentation/class_i_timeline_decoder.xhtml new file mode 100644 index 0000000000..4d14e254f3 --- /dev/null +++ b/Documentation/class_i_timeline_decoder.xhtml @@ -0,0 +1,421 @@ + + + + + + + + + + + + + +ArmNN: ITimelineDecoder Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  20.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Classes | +Public Types | +Public Member Functions | +List of all members
+
+
ITimelineDecoder Class Referenceabstract
+
+
+ +

#include <ITimelineDecoder.hpp>

+
+Inheritance diagram for ITimelineDecoder:
+
+
+ + +TimelineDecoder + +
+ + + + + + + + + + + + +

+Classes

struct  Entity
 
struct  Event
 
struct  EventClass
 
struct  Label
 
struct  Relationship
 
+ + + + + +

+Public Types

enum  TimelineStatus { TimelineStatus_Success, +TimelineStatus_Fail + }
 
enum  RelationshipType { RetentionLink, +ExecutionLink, +DataLink, +LabelLink + }
 
+ + + + + + + + + + + + + +

+Public Member Functions

virtual ~ITimelineDecoder ()=default
 
virtual TimelineStatus CreateEntity (const Entity &)=0
 
virtual TimelineStatus CreateEventClass (const EventClass &)=0
 
virtual TimelineStatus CreateEvent (const Event &)=0
 
virtual TimelineStatus CreateLabel (const Label &)=0
 
virtual TimelineStatus CreateRelationship (const Relationship &)=0
 
+

Detailed Description

+
+

Definition at line 11 of file ITimelineDecoder.hpp.

+

Member Enumeration Documentation

+ +

◆ RelationshipType

+ +
+
+ + + + + +
+ + + + +
enum RelationshipType
+ 		+strong
+
+ + + + + +
Enumerator
RetentionLink 
ExecutionLink 

Head retains(parents) Tail.

+
DataLink 

Head execution start depends on Tail execution completion.

+
LabelLink 

Head uses data of Tail.

+

Head uses label Tail (Tail MUST be a guid of a label).

+
+ +

Definition at line 22 of file ITimelineDecoder.hpp.

+
23  {
24  RetentionLink, /// Head retains(parents) Tail
25  ExecutionLink, /// Head execution start depends on Tail execution completion
26  DataLink, /// Head uses data of Tail
27  LabelLink /// Head uses label Tail (Tail MUST be a guid of a label).
28  };
+
armnn::profiling::ProfilingRelationshipType::DataLink
Head execution start depends on Tail execution completion.
+ + +
+
+
+ +

◆ TimelineStatus

+ +
+
+ + + + + +
+ + + + +
enum TimelineStatus
+ 		+strong
+
+ + + +
Enumerator
TimelineStatus_Success 
TimelineStatus_Fail 
+ +

Definition at line 16 of file ITimelineDecoder.hpp.

+
17  {
18  TimelineStatus_Success,
19  TimelineStatus_Fail
20  };
+
+
+

Constructor & Destructor Documentation

+ +

◆ ~ITimelineDecoder()

+ +
+
+ + + + + +
+ + + + + + + +
virtual ~ITimelineDecoder ()
+ 		+virtualdefault
+
+ +
+
+

Member Function Documentation

+ +

◆ CreateEntity()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual TimelineStatus CreateEntity (const Entity & )
+ 		+pure virtual
+
+ +

Implemented in TimelineDecoder.

+ +

Referenced by TimelineCaptureCommandHandler::ReadEntity().

+ +
+
+ +

◆ CreateEvent()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual TimelineStatus CreateEvent (const Event & )
+ 		+pure virtual
+
+ +

Implemented in TimelineDecoder.

+ +

Referenced by TimelineCaptureCommandHandler::ReadEvent().

+ +
+
+ +

◆ CreateEventClass()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual TimelineStatus CreateEventClass (const EventClass & )
+ 		+pure virtual
+
+ +

Implemented in TimelineDecoder.

+ +

Referenced by TimelineCaptureCommandHandler::ReadEventClass().

+ +
+
+ +

◆ CreateLabel()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual TimelineStatus CreateLabel (const Label & )
+ 		+pure virtual
+
+ +

Implemented in TimelineDecoder.

+ +

Referenced by TimelineCaptureCommandHandler::ReadLabel().

+ +
+
+ +

◆ CreateRelationship()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual TimelineStatus CreateRelationship (const Relationship & )
+ 		+pure virtual
+
+ +

Implemented in TimelineDecoder.

+ +

Referenced by TimelineCaptureCommandHandler::ReadRelationship().

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1