senzing::sdk::SzEnvironment Class Reference

Factory + lifecycle for the Senzing SDK subsystems. More...

#include <SzEnvironment.hpp>

Inheritance diagram for senzing::sdk::SzEnvironment:

Public Member Functions
virtual	~SzEnvironment ()=default
virtual SzProduct &	GetProduct ()=0
	Returns the env-owned SzProduct (lazily created).
virtual SzEngine &	GetEngine ()=0
	Returns the env-owned SzEngine (lazily created).
virtual SzConfigManager &	GetConfigManager ()=0
	Returns the env-owned SzConfigManager (lazily created).
virtual SzDiagnostic &	GetDiagnostic ()=0
	Returns the env-owned SzDiagnostic (lazily created).
virtual int64_t	GetActiveConfigID ()=0
	Returns the currently active configuration ID.
virtual void	Reinitialize (int64_t configID)=0
	Reinitializes the engine/diagnostic with the given configuration ID.
virtual void	Destroy ()=0
	Destroys the environment and all owned subsystems. Idempotent.
virtual bool	IsDestroyed ()=0
	Returns true once Destroy() has been initiated/completed.

Detailed Description

Factory + lifecycle for the Senzing SDK subsystems.

Constructor & Destructor Documentation

~SzEnvironment()

virtual senzing::sdk::SzEnvironment::~SzEnvironment ( )

virtualdefault

Member Function Documentation

Destroy()

virtual void senzing::sdk::SzEnvironment::Destroy ( )

pure virtual

Destroys the environment and all owned subsystems. Idempotent.

Implemented in senzing::sdk::core::SzCoreEnvironment.

GetActiveConfigID()

virtual int64_t senzing::sdk::SzEnvironment::GetActiveConfigID ( )

pure virtual

Returns the currently active configuration ID.

Implemented in senzing::sdk::core::SzCoreEnvironment.

GetConfigManager()

virtual SzConfigManager & senzing::sdk::SzEnvironment::GetConfigManager ( )

pure virtual

Returns the env-owned SzConfigManager (lazily created).

Implemented in senzing::sdk::core::SzCoreEnvironment.

GetDiagnostic()

virtual SzDiagnostic & senzing::sdk::SzEnvironment::GetDiagnostic ( )

pure virtual

Returns the env-owned SzDiagnostic (lazily created).

Implemented in senzing::sdk::core::SzCoreEnvironment.

GetEngine()

virtual SzEngine & senzing::sdk::SzEnvironment::GetEngine ( )

pure virtual

Returns the env-owned SzEngine (lazily created).

Implemented in senzing::sdk::core::SzCoreEnvironment.

GetProduct()

virtual SzProduct & senzing::sdk::SzEnvironment::GetProduct ( )

pure virtual

Returns the env-owned SzProduct (lazily created).

Reference valid until Destroy(). Throws SzEnvironmentDestroyedException after Destroy().

Implemented in senzing::sdk::core::SzCoreEnvironment.

IsDestroyed()

virtual bool senzing::sdk::SzEnvironment::IsDestroyed ( )

pure virtual

Returns true once Destroy() has been initiated/completed.

Implemented in senzing::sdk::core::SzCoreEnvironment.

Reinitialize()

virtual void senzing::sdk::SzEnvironment::Reinitialize ( int64_t  configID )

pure virtual

Reinitializes the engine/diagnostic with the given configuration ID.

Implemented in senzing::sdk::core::SzCoreEnvironment.

---

The documentation for this class was generated from the following file:

• senzing/sdk/SzEnvironment.hpp