Senzing C++ SDK
C++ SDK for Senzing v4, patterned after the official C# SDK
Loading...
Searching...
No Matches
SzEnvironment.hpp
Go to the documentation of this file.
1// SzEnvironment.hpp -- abstract interface mirroring C# Senzing.Sdk.SzEnvironment.
2//
3// The environment is the factory and lifecycle owner for the subsystem
4// instances (Product, Engine, ConfigManager, Diagnostic). Each Get* accessor
5// lazily creates and caches a single env-owned instance and returns a non-owning
6// reference; the returned references are invalid after Destroy().
7#ifndef SENZING_SDK_SZENVIRONMENT_HPP
8#define SENZING_SDK_SZENVIRONMENT_HPP
9
10#include <cstdint>
11
16
17namespace senzing::sdk {
18
21public:
22 virtual ~SzEnvironment() = default;
23
26 virtual SzProduct& GetProduct() = 0;
27
29 virtual SzEngine& GetEngine() = 0;
30
33
36
38 virtual int64_t GetActiveConfigID() = 0;
39
41 virtual void Reinitialize(int64_t configID) = 0;
42
44 virtual void Destroy() = 0;
45
47 virtual bool IsDestroyed() = 0;
48};
49
50} // namespace senzing::sdk
51
52#endif // SENZING_SDK_SZENVIRONMENT_HPP
Manages persisted Senzing configurations and the default config registry.
Definition SzConfigManager.hpp:18
Diagnostic operations against the Senzing repository.
Definition SzDiagnostic.hpp:11
The core Senzing entity-resolution engine.
Definition SzEngine.hpp:28
Factory + lifecycle for the Senzing SDK subsystems.
Definition SzEnvironment.hpp:20
virtual SzDiagnostic & GetDiagnostic()=0
Returns the env-owned SzDiagnostic (lazily created).
virtual SzEngine & GetEngine()=0
Returns the env-owned SzEngine (lazily created).
virtual void Reinitialize(int64_t configID)=0
Reinitializes the engine/diagnostic with the given configuration ID.
virtual int64_t GetActiveConfigID()=0
Returns the currently active configuration ID.
virtual ~SzEnvironment()=default
virtual bool IsDestroyed()=0
Returns true once Destroy() has been initiated/completed.
virtual void Destroy()=0
Destroys the environment and all owned subsystems. Idempotent.
virtual SzConfigManager & GetConfigManager()=0
Returns the env-owned SzConfigManager (lazily created).
virtual SzProduct & GetProduct()=0
Returns the env-owned SzProduct (lazily created).
Provides access to the Senzing product version and license metadata.
Definition SzProduct.hpp:10
Definition SzCoreConfig.hpp:20