Libargus API
Libargus Camera API
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
include
Argus
EventQueue.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
29
/**
30
* @file
31
* <b>Libargus API: Event Queue API</b>
32
*
33
* @b Description: Defines the EventQueue object and interface.
34
*/
35
36
#ifndef _ARGUS_EVENT_QUEUE_H
37
#define _ARGUS_EVENT_QUEUE_H
38
39
namespace
Argus
40
{
41
42
/**
43
* Object to receive and expose Events from an IEventProvider.
44
*
45
* @see IEventProvider::createEventQueue.
46
*
47
* @defgroup ArgusEventQueue EventQueue
48
* @ingroup ArgusObjects
49
*/
50
class
EventQueue
:
public
InterfaceProvider
,
public
Destructable
51
{
52
protected
:
53
~EventQueue
() {}
54
};
55
56
/**
57
* @class IEventQueue
58
*
59
* Interface to the core EventQueue methods.
60
*
61
* @ingroup ArgusEventQueue
62
*/
63
DEFINE_UUID
(InterfaceID, IID_EVENT_QUEUE, 944b11f6,e512,49ad,8573,fc,82,3e,02,25,ed);
64
class
IEventQueue
:
public
Interface
65
{
66
public
:
67
static
const
InterfaceID
&
id
() {
return
IID_EVENT_QUEUE; }
68
69
/**
70
* Returns the event types that this queue will receive.
71
* @param[out] types This vector will be populated with the event types
72
* registered to this queue.
73
*
74
* @returns success/status of the call.
75
*/
76
virtual
Status
getEventTypes
(std::vector<EventType>* types)
const
= 0;
77
78
/**
79
* Returns the next event in the queue (that is, the event at index 0). The returned
80
* event will be removed from the queue, though the object will remain valid
81
* according to the rules described by waitForEvents().
82
* If the queue is empty, returns NULL.
83
*/
84
virtual
const
Event
*
getNextEvent
() = 0;
85
86
/**
87
* Returns the number of events in the queue.
88
*/
89
virtual
uint32_t
getSize
()
const
= 0;
90
91
/**
92
* Returns the event with the given index, where index 0 corresponds to the oldest
93
* event and [getSize() - 1] is the newest. The returned event is not removed
94
* from the queue. If index is not in [0, getSize()-1], NULL is returned.
95
*/
96
virtual
const
Event
*
getEvent
(uint32_t index)
const
= 0;
97
98
protected
:
99
~IEventQueue
() {}
100
};
101
102
}
// namespace Argus
103
104
#endif // _ARGUS_EVENT_QUEUE_H
Generated on Thu Jul 20 2023 04:03:52 for Libargus API by
1.8.1