PapillonSDK.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015-2018 Digital Barriers plc. All rights reserved.
3  * Contact: http://www.digitalbarriers.com/
4  *
5  * This file is part of the Papillon SDK.
6  *
7  * You can't use, modify or distribute any part of this file without
8  * the explicit written agreements of Digital Barriers.
9  */
10 
15 #pragma once
16 #include <PapillonCommon.h>
17 #include <PString.h>
18 
19 PAPILLON_BEGIN_NAMESPACE
20 
21 class PProperties;
22 class PVersion;
23 
34 class PAPILLON_API_CORE PapillonSDK
35 {
36 public:
43  {
44  E_NONE = 0,
45  E_CONSOLE_LOGGER_INFO_LEVEL = 1,
46  E_CONSOLE_LOGGER_DEBUG_LEVEL = 2,
47  E_CONSOLE_LOGGER_IF_DEBUG = 4,
48  E_DONT_LOAD_PLUGINS = 8,
49  E_SILENT_START = 16
50  };
51 
52 public:
67  static PResult SetLicense(const PString& license);
68 
74  static void SetPluginsPath(const PString& pluginsPath);
75 
86  static void SetNumberOfThreads(papillon::int32 numberOfThreads);
87 
124  static PResult Initialise(papillon::int32 flags = E_CONSOLE_LOGGER_INFO_LEVEL);
125 
129  static bool IsInitialised();
130 
142  static PResult Finalise();
143 
147  static PVersion GetVersion();
148 
154  static void EnableMonitoring(const PProperties& parameters);
155 
156 private:
157  // this class cannot be instantiated
158  PapillonSDK();
159  PapillonSDK(const PapillonSDK&);
160 };
161 
162 PAPILLON_END_NAMESPACE
The PString class provides an Unicode character strings.
Definition: PString.h:37
The PVersion class represents a software version number: major.minor[.maintenance[.build]]; immutable, so thread-safe.
Definition: PVersion.h:26
The PResult class represents the result returned by most of Papillon functions; this class is used to...
Definition: PResult.h:159
The PProperties class represents a container of properties; each property has a name (PString) and a ...
Definition: PProperties.h:38
Class PString: an unicode character strings (use copy-on-write idiom).
EPapillonOptions
Flags used by the PapillonSDK::Initialise() function to set the startup behaviour of this SDK...
Definition: PapillonSDK.h:42
The PapillonSDK class provides global functions to initialise and finalise the Papillon SDK...
Definition: PapillonSDK.h:34