tom::tsdb::engine Class Reference

#include <tom-tsdb/engine.hpp>

Collaboration diagram for tom::tsdb::engine:

Classes
class	module_loader

Public Member Functions
provider &	get_provider ()
provider &	get_provider (const char *name)
provider &	get_provider (const tom::observation &name)
const repository_meta_data_vec &	get_repositories_meta_data () const
session_sptr	get_session ()
session_sptr	get_session (const char *name)
session_sptr	get_session (const tom::observation &name)
void	update_screening_dbs ()

Static Public Member Functions
static engine &	Instance ()
static bool	use_screening_dbs ()
static void	use_screening_dbs (bool use)
static const char *	version ()

Protected Member Functions
tom::String	get_module_name (const tom::observation &name)

Protected Attributes
tom::xml_doc *	m_config
tom::String	m_default_provider
tom::logger *	m_logger
tom::String	m_module_dir
module_loader *	m_module_loader
repository_meta_data_vec	m_repository_names
screening_manager *	m_screening_mgr { nullptr }

Static Protected Attributes
static bool	s_use_screening_dbs = false

Detailed Description

engine is the singleton class that controls all access to tsdb assets including sessions, connections, datastores, time_series, and more. It also handles the runtime requirements of locating and loading the various modules that provide persistence handling.

Member Function Documentation

get_provider() [1/3]

provider & tom::tsdb::engine::get_provider

(

)

Retrieve the provider for the default session as defined in the tom-environment.xml config file.

get_provider() [2/3]

provider & tom::tsdb::engine::get_provider ( const char *  name )

inline

Retrieve the provider for the repository with name = 'name' as defined in the tom-environment.xml config file.

get_provider() [3/3]

provider & tom::tsdb::engine::get_provider

(

const tom::observation &

name

)

Retrieve the provider for the repository with name = 'name' as defined in the tom-environment.xml config file.

get_repositories_meta_data()

const repository_meta_data_vec & tom::tsdb::engine::get_repositories_meta_data

(

)

const

Retrieve a vector of repository_meta_data that describes the repositories available on this system as described in the tom-environment.xml config file.

get_session() [1/3]

session_sptr tom::tsdb::engine::get_session

(

)

Retrieve the default session object as defined in the tom-environment.xml config file.

get_session() [2/3]

session_sptr tom::tsdb::engine::get_session ( const char *  name )

inline

Retrieve a session for the repository with name = 'name'

get_session() [3/3]

session_sptr tom::tsdb::engine::get_session

(

const tom::observation &

name

)

Retrieve a session for the repository with name = 'name'

Instance()

engine & tom::tsdb::engine::Instance ( )

static

engine is a singleton, and may only be accessed via the static Instance() method. The first time the Instance method is called, it may throw exceptions concerning a malformed tom-environment.xml config file, or possibly directory rights when reading the specified module directory. Subsequent calls need not worry about exceptions

version()

const char * tom::tsdb::engine::version ( )

static

Get the version for the tsdb library.

---

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

• tom-tsdb/engine.hpp
• engine.cpp