File: reason.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 (58 lines) | stat: -rw-r--r-- 1,784 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
/*
 * 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 BIOMETRYD_REASON_H_
#define BIOMETRYD_REASON_H_

#include <biometry/visibility.h>

#include <string>

namespace biometry
{
/// @brief Reason models the reason for requesting an identification or verification operation.
class BIOMETRY_DLL_PUBLIC Reason
{
public:
    /// @brief unknown returns a Reason instance referring to the unknown reason.
    static Reason unknown();

    /// @brief Reason initializes an instance to be equal to unknown().
    Reason();

    /// @brief Reason initializes an instance with the given string s.
    explicit Reason(const std::string& s);

    /// @brief as_string returns the string representation of this instance.
    const std::string& as_string() const;

    /// @brief operator std::string returns the string representation of this instance.
    operator std::string() const;

private:
    /// @cond
    std::string value;
    /// @endcond
};

/// @brief operator== returns true if lhs has the same name as rhs.
BIOMETRY_DLL_PUBLIC bool operator==(const Reason& lhs, const Reason& rhs);
}

#endif // BIOMETRYD_REASON_H_