RDB 2
Main Page
Related Pages
Namespaces
Classes
Files
Examples
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
riegl
rdb
progress.hpp
Go to the documentation of this file.
1
/*
2
*******************************************************************************
3
*
4
* Copyright 2021 RIEGL Laser Measurement Systems
5
*
6
* Licensed under the Apache License, Version 2.0 (the "License");
7
* you may not use this file except in compliance with the License.
8
* You may obtain a copy of the License at
9
*
10
* http://www.apache.org/licenses/LICENSE-2.0
11
*
12
* Unless required by applicable law or agreed to in writing, software
13
* distributed under the License is distributed on an "AS IS" BASIS,
14
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
* See the License for the specific language governing permissions and
16
* limitations under the License.
17
*
18
* SPDX-License-Identifier: Apache-2.0
19
*
20
*******************************************************************************
21
*/
22
/*!
23
*******************************************************************************
24
*
25
* \file progress.hpp
26
* \author RIEGL LMS GmbH, Austria
27
* \brief Operation progress feedback tools
28
* \version 2016-06-14/AW: Initial version
29
*
30
*******************************************************************************
31
*/
32
33
#ifndef RIEGL_RDB_PROGRESS_HPP
34
#define RIEGL_RDB_PROGRESS_HPP
35
36
//---< INCLUDES >---------------------------------------------------------------
37
38
#include <cstdint>
39
40
//---< NAMESPACE >--------------------------------------------------------------
41
42
namespace
riegl {
43
namespace
rdb {
44
45
//---< TYPES >------------------------------------------------------------------
46
47
//______________________________________________________________________________
48
/*!
49
* \brief Progress callback function type
50
*
51
* Various RDB API functions may accept an optional progress function pointer.
52
* That progress function will be called by the API function on a regular basis
53
* to communicate the progress of the operation to the client application.
54
*
55
* Along with the function pointer a pointer to some user data may be provided
56
* to the API function. This pointer will then be provided to the callback
57
* function which can use it to get or store some context information. Please
58
* note that the library doesn't use the user data in any way - it is just
59
* relayed from the caller to the progress callback function.
60
*
61
* It is guaranteed that the callback function is only called from within the
62
* API function (i.e. it is not called after the API function returned). But
63
* it is =NOT= guaranteed that the callback function is called from within the
64
* same thread context as the API function.
65
*/
66
typedef
void (*
Progress
)(
67
uint8_t progress,
//!< progress value in percent [0..100%]
68
void
*userdata
//!< pointer to user (client) data
69
);
70
71
}}
// namespace riegl::rdb
72
73
#endif // RIEGL_RDB_PROGRESS_HPP
riegl::rdb::Progress
void(* Progress)(uint8_t progress, void *userdata)
Progress callback function type.
Definition:
progress.hpp:66
Generated on Wed Jun 30 2021 08:19:18 for RDB 2 by
1.8.6