File: identifier.h

package info (click to toggle)
biometryd 0.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,500 kB
  • sloc: cpp: 10,221; ansic: 191; python: 42; makefile: 20
file content (64 lines) | stat: -rw-r--r-- 2,092 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (C) 2016 Canonical, Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 *
 */

#ifndef BIOMETRY_IDENTIFIER_H_
#define BIOMETRY_IDENTIFIER_H_

#include <biometry/do_not_copy_or_move.h>
#include <biometry/operation.h>
#include <biometry/progress.h>
#include <biometry/user.h>

#include <set>

namespace biometry
{
/// @cond
class Application;
class Reason;
class User;
/// @endcond

/// @brief Verification bundles the types passed to an observer of verification operations.
struct BIOMETRY_DLL_PUBLIC Identification
{
    typedef biometry::Progress Progress; ///< Progress information about the completion status of an operation.
    typedef std::string Reason;          ///< Details about cancelation of an operation.
    typedef std::string Error;           ///< Describes error conditions.
    typedef User Result;                 ///< Describes the result of an identification operation.
};

/// @brief Verifier abstracts verification of a user.
class BIOMETRY_DLL_PUBLIC Identifier : private DoNotCopyOrMove
{
public:
    // Safe us some typing
    typedef std::shared_ptr<Identifier> Ptr;

    /// @brief identify_user returns an operation that represents the identification of a user given a set of candidates with the given reason.
    virtual Operation<Identification>::Ptr identify_user(const Application& app, const Reason& reason) = 0;

protected:
    /// @cond
    Identifier() = default;
    /// @endcond
};
}

#endif // BIOMETRY_IDENTIFIER_H_