Jetson Linux API Reference

32.7.3 Release
Event.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2017, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of NVIDIA CORPORATION nor the names of its
13  * contributors may be used to endorse or promote products derived
14  * from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
36 #ifndef _ARGUS_EVENT_H
37 #define _ARGUS_EVENT_H
38 
39 namespace Argus
40 {
41 
51 class Event : public InterfaceProvider
52 {
53 protected:
54  ~Event() {}
55 };
56 
62 class EventType : public NamedUUID
63 {
64 public:
65  EventType(uint32_t time_low_
66  , uint16_t time_mid_
67  , uint16_t time_hi_and_version_
68  , uint16_t clock_seq_
69  , uint8_t c0, uint8_t c1, uint8_t c2, uint8_t c3, uint8_t c4, uint8_t c5
70  , const char* name)
71  : NamedUUID(time_low_, time_mid_, time_hi_and_version_, clock_seq_,
72  c0, c1, c2, c3, c4, c5, name)
73  {}
74 
76  : NamedUUID(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, "EVENT_TYPE_UNSPECIFIED")
77  {}
78 };
79 
80 
81 /*
82  * Core Event types
83  */
84 
91 DEFINE_UUID(EventType, EVENT_TYPE_ERROR, 2c80d8b0,2bfd,11e5,a2cb,08,00,20,0c,9a,66);
92 
99 DEFINE_UUID(EventType, EVENT_TYPE_CAPTURE_STARTED, 2c80d8b1,2bfd,11e5,a2cb,08,00,20,0c,9a,66);
100 
107 DEFINE_UUID(EventType, EVENT_TYPE_CAPTURE_COMPLETE, 2c80d8b2,2bfd,11e5,a2cb,08,00,20,0c,9a,66);
108 
109 
117 DEFINE_UUID(InterfaceID, IID_EVENT, 98bcb49e,fd7d,11e4,a322,16,97,f9,25,ec,7b);
118 class IEvent : public Interface
119 {
120 public:
121  static const InterfaceID& id() { return IID_EVENT; }
122 
126  virtual EventType getEventType() const = 0;
127 
131  virtual uint64_t getTime() const = 0;
132 
136  virtual uint32_t getCaptureId() const = 0;
137 
138 protected:
139  ~IEvent() {}
140 };
141 
149 DEFINE_UUID(InterfaceID, IID_EVENT_ERROR, 13e0fc70,1ab6,11e5,b939,08,00,20,0c,9a,66);
150 class IEventError : public Interface
151 {
152 public:
153  static const InterfaceID& id() { return IID_EVENT_ERROR; }
154 
158  virtual Status getStatus() const = 0;
159 
160 protected:
162 };
163 
171 DEFINE_UUID(InterfaceID, IID_EVENT_CAPTURE_COMPLETE, 8b2b40b5,f1e4,4c4d,ae1c,f3,93,f6,54,06,d5);
173 {
174 public:
175  static const InterfaceID& id() { return IID_EVENT_CAPTURE_COMPLETE; }
176 
183  virtual const CaptureMetadata* getMetadata() const = 0;
184 
189  virtual Status getStatus() const = 0;
190 
191 protected:
193 };
194 
195 } // namespace Argus
196 
197 #endif // _ARGUS_EVENT_H
Argus::IEventError::getStatus
virtual Status getStatus() const =0
Returns the Status value describing the error.
Argus::IEvent::id
static const InterfaceID & id()
Definition: Event.h:121
Argus::DEFINE_UUID
DEFINE_UUID(ExtensionName, EXT_BAYER_AVERAGE_MAP, 12c3de20, 64c5, 11e6, bdf4, 08, 00, 20, 0c, 9a, 66)
Argus::NamedUUID
A universally unique identifier with a name (used for debugging purposes).
Definition: UUID.h:72
Argus::IEventError
Definition: Event.h:150
Argus
Definition: BayerAverageMap.h:39
Argus::IEventError::~IEventError
~IEventError()
Definition: Event.h:161
Argus::IEvent::getTime
virtual uint64_t getTime() const =0
Returns the time of the event, in nanoseconds.
Argus::IEvent::getCaptureId
virtual uint32_t getCaptureId() const =0
Returns the capture id for the event.
Argus::CaptureMetadata
Definition: CaptureMetadata.h:48
Argus::IEvent
Definition: Event.h:118
Argus::EventType
A unique identifier for a particular type of Event.
Definition: Event.h:62
Argus::Interface
The top-level interface class.
Definition: Types.h:327
Argus::IEventCaptureComplete::getMetadata
virtual const CaptureMetadata * getMetadata() const =0
Returns all dynamic metadata associated with this capture.
Argus::InterfaceID
A unique identifier for a libargus Interface.
Definition: Types.h:337
Argus::InterfaceProvider
The base interface for a class that provides libargus Interfaces.
Definition: Types.h:358
Argus::IEventCaptureComplete::~IEventCaptureComplete
~IEventCaptureComplete()
Definition: Event.h:192
Argus::IEventCaptureComplete::getStatus
virtual Status getStatus() const =0
Returns the error status of the metadata event.
Argus::EventType::EventType
EventType()
Definition: Event.h:75
Argus::Event
Definition: Event.h:51
Argus::Event::~Event
~Event()
Definition: Event.h:54
Argus::IEventError::id
static const InterfaceID & id()
Definition: Event.h:153
Argus::IEventCaptureComplete::id
static const InterfaceID & id()
Definition: Event.h:175
Argus::IEvent::getEventType
virtual EventType getEventType() const =0
Returns the event type.
Argus::IEventCaptureComplete
Definition: Event.h:172
Argus::EventType::EventType
EventType(uint32_t time_low_, uint16_t time_mid_, uint16_t time_hi_and_version_, uint16_t clock_seq_, uint8_t c0, uint8_t c1, uint8_t c2, uint8_t c3, uint8_t c4, uint8_t c5, const char *name)
Definition: Event.h:65
Argus::Status
Status
Status values returned by API function calls.
Definition: Types.h:93
Argus::IEvent::~IEvent
~IEvent()
Definition: Event.h:139