dbe::confaccessor Class Reference

#include <confaccessor.hpp>

Inheritance diagram for dbe::confaccessor:

Collaboration diagram for dbe::confaccessor:

Public Types
typedef config_internal_change	t_internal_change
typedef std::stack< t_internal_change, std::vector< t_internal_change > >	t_internal_changes_stack
typedef cptr< t_internal_changes_stack >	t_internal_changes_stack_cptr
typedef QUndoStack	t_undo_stack
typedef cptr< t_undo_stack >	t_undo_stack_cptr

Public Slots
void	GetFileCache (QList< QStringList > &FileCache)

Signals
void	object_created (QString const &source, dref const &obj)
void	object_renamed (QString const &source, dref const &obj)
void	object_changed (QString const &source, dref const &obj)
void	object_deleted (QString const &source, dref const &obj)
void	db_committed (const std::list< std::string > &files, const std::string &msg)
void	IncludeFileDone ()
void	RemoveFileDone ()
void	ResetTree ()
void	ExternalChangesDetected ()
void	ExternalChangesAccepted ()

Public Member Functions
	~confaccessor ()
void	force_emit_object_created (QString const &, dref const)
void	force_emit_object_deleted (QString const &, dref const)
void	force_emit_object_renamed (QString const &, dref const)
void	force_emit_object_changed (QString const &, dref const)
QList< QStringList >	GetIncludedFileCache () const
void	addfile (std::string const &db, std::string const &fn)
void	removefile (std::string const &db, std::string const &fn)

Static Public Member Functions
static confaccessor &	ref ()
static void	init ()
static bool	load (bool subscribeToChanges=true)
static void	abort ()
static bool	is_database_loaded ()
static bool	enabled ()
static std::list< std::string >	save (QString const &)
static cptr< datahandler >	gethandler ()
static cptr< ui::config::info >	guiconfig ()
static t_undo_stack_cptr	get_commands ()
static void	clear_commands ()
static t_internal_changes_stack_cptr	get_internal_change_stack ()
static void	setdbinfo (QString const &location, dbinfo const itype=dbinfo::oks)
static void	setdblocation (const QString &Implementation)
static bool	check_file_rw (const QString &FileName)
static QString	dbfullname ()
static QString	db_implementation_name ()
static void	CallbackFunction (const std::vector< dunedaq::conffwk::ConfigurationChange * > &changes, void *parameter)
static void	unsubscribe ()
static std::list< std::string >	uncommitted_files ()
static int	get_total_objects ()
static void	set_total_objects (int const i)
static void	increase_total_objects (int const i)

Private Types
typedef std::mutex	t_mutex
typedef std::lock_guard< t_mutex >	t_lock
typedef std::vector< ConfigWrapperExternalChange >	t_external_changes_stack

Private Member Functions
void	setenabled ()
void	setdisabled ()
template<dbinfo N>
void	set_dbinfo (QString const &p)
void	docallback (std::vector< dunedaq::conffwk::ConfigurationChange * > const &changes, void *parameter)
	confaccessor ()
	confaccessor (confaccessor const &)=delete
confaccessor &	operator= (confaccessor const &)=delete

Private Attributes
QString	this_dblocation
QString	this_resource_location
dunedaq::conffwk::Configuration::CallbackId	CallId
std::shared_ptr< t_internal_changes_stack >	internal_change_stack
t_external_changes_stack	external_change_stack
t_undo_stack *	sequenced_command_stack
datahandler *	editconfig
ui::config::info *	coreconfig
QList< QStringList >	IncludedFileCache
t_mutex	this_change_enabled_mutex
t_mutex	mut_changes
t_mutex	force_mut
bool	this_change_enabled
int	this_total_objects

Friends
class	dbaccessor

Detailed Description

Definition at line 58 of file confaccessor.hpp.

Member Typedef Documentation

t_external_changes_stack

std::vector<ConfigWrapperExternalChange> dbe::confaccessor::t_external_changes_stack

private

Definition at line 232 of file confaccessor.hpp.

t_internal_change

config_internal_change dbe::confaccessor::t_internal_change

Definition at line 63 of file confaccessor.hpp.

t_internal_changes_stack

std::stack<t_internal_change, std::vector<t_internal_change> > dbe::confaccessor::t_internal_changes_stack

Definition at line 65 of file confaccessor.hpp.

t_internal_changes_stack_cptr

cptr<t_internal_changes_stack> dbe::confaccessor::t_internal_changes_stack_cptr

Definition at line 66 of file confaccessor.hpp.

t_lock

std::lock_guard<t_mutex> dbe::confaccessor::t_lock

private

Definition at line 230 of file confaccessor.hpp.

t_mutex

std::mutex dbe::confaccessor::t_mutex

private

Definition at line 229 of file confaccessor.hpp.

t_undo_stack

QUndoStack dbe::confaccessor::t_undo_stack

Definition at line 68 of file confaccessor.hpp.

t_undo_stack_cptr

cptr<t_undo_stack> dbe::confaccessor::t_undo_stack_cptr

Definition at line 69 of file confaccessor.hpp.

Constructor & Destructor Documentation

~confaccessor()

dbe::confaccessor::~confaccessor

(

)

Definition at line 51 of file confaccessor.cpp.

{
  delete editconfig;
  delete coreconfig;
  {
    dbholder::t_lock l ( dbholder::database_lock );
    delete dbholder::database;
  }
}

confaccessor() [1/2]

dbe::confaccessor::confaccessor ( )

private

Definition at line 40 of file confaccessor.cpp.

  : CallId ( nullptr ),
    internal_change_stack ( new t_internal_changes_stack
                            { } ),
    sequenced_command_stack ( new QUndoStack() ),
    editconfig ( new datahandler() ),
    coreconfig ( nullptr ),
    this_change_enabled ( false ),
    this_total_objects ( 0 )
{}

confaccessor() [2/2]

dbe::confaccessor::confaccessor ( confaccessor const & )

privatedelete

Member Function Documentation

abort()

void dbe::confaccessor::abort ( )

static

Abort all database changes

Definition at line 272 of file confaccessor.cpp.

{
  dbaccessor::dbptr()->abort();
}

addfile()

void dbe::confaccessor::addfile	(	std::string const &	db,
		std::string const &	fn )

Definition at line 386 of file confaccessor.cpp.

{
  if ( not enabled() )
  {
    throw daq::dbe::ChangeNotAllowed ( ERS_HERE );
  }
 
  dbaccessor::dbptr()->add_include ( db, fn );
  emit IncludeFileDone();
}

CallbackFunction()

void dbe::confaccessor::CallbackFunction ( const std::vector< dunedaq::conffwk::ConfigurationChange * > & changes, void * parameter )

static

Definition at line 411 of file confaccessor.cpp.

{
  dbe::confaccessor::ref().docallback ( changes, parameter );
}

check_file_rw()

bool dbe::confaccessor::check_file_rw ( const QString & FileName )

static

Definition at line 240 of file confaccessor.cpp.

{
  try
  {
    if ( not fn.contains ( "schema" ) )
    {
      return dbaccessor::dbptr()->is_writable ( fn.toStdString() );
    }
  }
  catch ( dunedaq::conffwk::Generic const & ex )
  {
    ERROR ( "Not possible to operate on file", dbe::config::errors::parse ( ex ),
            "\n\nCheck filename:", fn.toStdString() );
  }
 
  return false;
}

clear_commands()

void dbe::confaccessor::clear_commands ( )

static

Clear internal changes commands

Definition at line 259 of file confaccessor.cpp.

{
  if ( ref().get_commands().get() )
  {
      ref().get_commands()->clear();
      t_internal_changes_stack cleared{ };
      ref().get_internal_change_stack()->swap ( cleared );
  }
}

db_committed

void dbe::confaccessor::db_committed ( const std::list< std::string > & files, const std::string & msg )

signal

db_implementation_name()

QString dbe::confaccessor::db_implementation_name ( )

static

Definition at line 125 of file confaccessor.cpp.

{
  return ref().this_resource_location;
}

dbfullname()

QString dbe::confaccessor::dbfullname ( )

static

Definition at line 120 of file confaccessor.cpp.

{
  return ref().this_dblocation;
}

docallback()

void dbe::confaccessor::docallback ( std::vector< dunedaq::conffwk::ConfigurationChange * > const & changes, void * parameter )

private

Definition at line 418 of file confaccessor.cpp.

{
  Q_UNUSED ( parameter );
 
  t_lock l ( mut_changes );
  external_change_stack.clear();
 
  for ( ConfigurationChange * Change : changes )
  {
      const auto& cl = Change->get_class_name();
      const auto& mod = Change->get_modified_objs();
      const auto& cre = Change->get_created_objs();
      const auto& rem = Change->get_removed_objs();
 
      external_change_stack.push_back ( { cl, mod, cre, rem } );
   }
 
      emit ExternalChangesAccepted();
}

enabled()

bool dbe::confaccessor::enabled ( )

static

Check if changes are allowed

Returns

true in case changes are allowed

Definition at line 64 of file confaccessor.cpp.

{
  t_lock l ( ref().this_change_enabled_mutex );
  return ref().this_change_enabled;
}

ExternalChangesAccepted

void dbe::confaccessor::ExternalChangesAccepted ( )

signal

ExternalChangesDetected

void dbe::confaccessor::ExternalChangesDetected ( )

signal

force_emit_object_changed()

void dbe::confaccessor::force_emit_object_changed	(	QString const &	src,
		dref const	obj )

Force emit an object changed signal from this object

Parameters

UUID	string representation of the object causing the creation
the	object that was changed

Definition at line 103 of file confaccessor.cpp.

{
  t_lock l ( force_mut );
  emit object_changed ( src, obj );
}

force_emit_object_created()

void dbe::confaccessor::force_emit_object_created	(	QString const &	src,
		dref const	obj )

Force emit a creation signal from this object

Definition at line 85 of file confaccessor.cpp.

{
  t_lock l ( force_mut );
  emit object_created ( src, obj );
}

force_emit_object_deleted()

void dbe::confaccessor::force_emit_object_deleted	(	QString const &	src,
		dref const	obj )

Force emit that an object has been deleted

Parameters must be passed by value, because this signal may be emitted from other than QThreads threads, which may cause a temporary to die prematurely in the other thread.

Parameters

UUID	string representation of the object causing the creation
a	description of the object having be created

Definition at line 97 of file confaccessor.cpp.

{
  t_lock l ( force_mut );
  emit object_deleted ( src, obj );
}

force_emit_object_renamed()

void dbe::confaccessor::force_emit_object_renamed	(	QString const &	src,
		dref const	obj )

Force emit that an object has been renamed

Parameters

UUID	string representation of the object causing the creation
a	description of the object having be changed, actually contains the original name

Definition at line 91 of file confaccessor.cpp.

{
  t_lock l ( force_mut );
  emit object_renamed ( src, obj );
}

get_commands()

dbe::confaccessor::t_undo_stack_cptr dbe::confaccessor::get_commands ( )

static

Get a thread safe pointer to the internal command stack

Returns

Definition at line 145 of file confaccessor.cpp.

{
  static t_undo_stack_cptr rp ( ref().sequenced_command_stack );
  return rp;
}

get_internal_change_stack()

dbe::confaccessor::t_internal_changes_stack_cptr dbe::confaccessor::get_internal_change_stack ( )

static

Get a thread safe pointer to the internal change stack

Returns

Definition at line 451 of file confaccessor.cpp.

{
  static t_internal_changes_stack_cptr rp ( ref().internal_change_stack.get() );
  return rp;
}

get_total_objects()

int dbe::confaccessor::get_total_objects ( )

static

Definition at line 154 of file confaccessor.cpp.

{
  return ref().this_total_objects;
}

GetFileCache

void dbe::confaccessor::GetFileCache ( QList< QStringList > & FileCache )

slot

Definition at line 112 of file confaccessor.cpp.

{
  IncludedFileCache = FileCache;
}

gethandler()

cptr< dbe::datahandler > dbe::confaccessor::gethandler ( )

static

Get a thread safe pointer to the data handler

Returns

returns a thread safe pointer

Definition at line 133 of file confaccessor.cpp.

{
  static cptr<datahandler> r ( ref().editconfig );
  return r;
}

GetIncludedFileCache()

QList< QStringList > dbe::confaccessor::GetIncludedFileCache

(

)

const

Definition at line 378 of file confaccessor.cpp.

{
  return IncludedFileCache;
}

guiconfig()

cptr< dbe::ui::config::info > dbe::confaccessor::guiconfig ( )

static

Access the default oks configuration type information

Returns

Definition at line 139 of file confaccessor.cpp.

{
  static cptr<dbe::ui::config::info> r ( confaccessor::ref().coreconfig );
  return r;
}

IncludeFileDone

void dbe::confaccessor::IncludeFileDone ( )

signal

increase_total_objects()

void dbe::confaccessor::increase_total_objects ( int const i )

static

Definition at line 159 of file confaccessor.cpp.

{
  ref().this_total_objects += i;
}

init()

void dbe::confaccessor::init ( )

static

Must be called to read default OKS configuration type information

Definition at line 347 of file confaccessor.cpp.

{
  QString DUNEDAQ_DB_PATH = getenv ( "DUNEDAQ_DB_PATH" );
  QString GUI_DATA = getenv ( "OKS_GUI_INIT_DATA" );
 
  QStringList CONFIG_DATABASE = GUI_DATA.split ( ":", QString::SkipEmptyParts );
  QStringList DUNEDAQ_DB_PATH_SPLIT = DUNEDAQ_DB_PATH.split ( ":", QString::SkipEmptyParts );
 
  // We need to read the current configuration ( to retrieve parameters affecting dbe )
 
  std::vector<std::string> full_path_names;
 
  for ( QString & FileName : CONFIG_DATABASE )
  {
 
    for ( QString & PATH : DUNEDAQ_DB_PATH_SPLIT )
    {
      QFileInfo CheckFile ( PATH + "/" + FileName );
 
      if ( CheckFile.exists() and CheckFile.isFile() )
      {
        QString fullpathname = PATH + "/" + FileName;
        full_path_names.push_back ( fullpathname.toStdString() );
      }
    }
  }
 
  confaccessor::ref().coreconfig = new ui::config::info ( full_path_names );
 
}

is_database_loaded()

bool dbe::confaccessor::is_database_loaded ( )

static

Check if the underlying database is actually loaded

Returns

true when the database is loaded

Definition at line 232 of file confaccessor.cpp.

{
  return dbaccessor::dbptr().get() != nullptr;
}

load()

bool dbe::confaccessor::load ( bool subscribeToChanges = true )

static

Load the database from the already specified source

Returns

true when the database has been loaded

Definition at line 286 of file confaccessor.cpp.

{
  try
  {
    dbholder::t_lock l ( dbholder::database_lock );
 
    if ( dbholder::database == nullptr )
    {
      dbholder::database = new Configuration ( ref().this_resource_location.toStdString() );
 
      if ( subscribeToChanges == true ) {
          ref().CallId = dbholder::database->subscribe (
                           ConfigurationSubscriptionCriteria(),
                           &confaccessor::CallbackFunction,
                           reinterpret_cast<void *> ( dbholder::database ) );
          }
    }
    else
    {
      dbe::inner::dbcontroller::flush();
      delete dbholder::database;
      dbholder::database = new Configuration ( ref().this_resource_location.toStdString() );
    }
 
    dbholder::database->prefetch_all_data();
 
    dbholder::database_concurrent_ptr = cptr<Configuration> ( dbholder::database );
    return true;
  }
  catch ( dunedaq::conffwk::Exception const & e )
  {
    FAIL ( "Database loading failed", dbe::config::errors::parse ( e ).c_str() );
    return false;
  }
 
}

object_changed

void dbe::confaccessor::object_changed ( QString const & source, dref const & obj )

signal

object_created

void dbe::confaccessor::object_created ( QString const & source, dref const & obj )

signal

object_deleted

void dbe::confaccessor::object_deleted ( QString const & source, dref const & obj )

signal

object_renamed

void dbe::confaccessor::object_renamed ( QString const & source, dref const & obj )

signal

operator=()

confaccessor & dbe::confaccessor::operator= ( confaccessor const & )

privatedelete

ref()

dbe::confaccessor & dbe::confaccessor::ref ( )

static

Retrieve a reference to this singleton

Returns

a reference to this

Definition at line 31 of file confaccessor.cpp.

{
  static confaccessor me;
  return me;
}

removefile()

void dbe::confaccessor::removefile	(	std::string const &	db,
		std::string const &	fn )

Definition at line 397 of file confaccessor.cpp.

{
  if ( not enabled() )
  {
    throw daq::dbe::ChangeNotAllowed ( ERS_HERE );
  }
 
  dbaccessor::dbptr()->remove_include ( db, fn );
  emit RemoveFileDone();
}

RemoveFileDone

void dbe::confaccessor::RemoveFileDone ( )

signal

ResetTree

void dbe::confaccessor::ResetTree ( )

signal

save()

std::list< std::string > dbe::confaccessor::save ( QString const & CommitMessage )

static

Commit changes to the database

Parameters

CommitMessage

to enter for the database

Definition at line 323 of file confaccessor.cpp.

{
  try
  {
    std::list<std::string> tobecommited{};
 
    if ( ref().is_database_loaded() )
    {
      dbaccessor::dbptr()->get_updated_dbs ( tobecommited );
      dbaccessor::dbptr()->commit ( CommitMessage.toStdString() );
      confaccessor::ref().db_committed(tobecommited, CommitMessage.toStdString());
    }
 
    return tobecommited;
  }
  catch ( dunedaq::conffwk::Exception const & e )
  {
    throw daq::dbe::CouldNotCommitChanges ( ERS_HERE, dbe::config::errors::parse ( e ) );
  }
}

set_dbinfo()

template<dbinfo N>

template void dbe::confaccessor::set_dbinfo< dbinfo::rdb > ( QString const & p )

private

Set database information

Parameters

p	the location string

set_total_objects()

void dbe::confaccessor::set_total_objects ( int const i )

static

Definition at line 164 of file confaccessor.cpp.

{
  ref().this_total_objects = i;
}

setdbinfo()

void dbe::confaccessor::setdbinfo ( QString const & location, dbinfo const itype = dbinfo::oks )

static

Definition at line 204 of file confaccessor.cpp.

{
  switch ( itype )
  {
 
  case dbinfo::oks:
    ref().set_dbinfo<dbinfo::oks> ( location );
    break;
 
  case dbinfo::roks:
    ref().set_dbinfo<dbinfo::roks> ( location );
    break;
 
  case dbinfo::rdb:
    ref().set_dbinfo<dbinfo::rdb> ( location );
    break;
 
  default:
    ref().setenabled();
    break;
  }
}

setdblocation()

void dbe::confaccessor::setdblocation ( const QString & Implementation )

static

Definition at line 227 of file confaccessor.cpp.

{
  ref().this_resource_location = Implementation;
}

setdisabled()

void dbe::confaccessor::setdisabled ( )

private

Definition at line 76 of file confaccessor.cpp.

{
  t_lock l ( this_change_enabled_mutex );
  this_change_enabled = false;
}

setenabled()

void dbe::confaccessor::setenabled ( )

private

Definition at line 70 of file confaccessor.cpp.

{
  t_lock l ( this_change_enabled_mutex );
  this_change_enabled = true;
}

uncommitted_files()

std::list< std::string > dbe::confaccessor::uncommitted_files ( )

static

Definition at line 278 of file confaccessor.cpp.

                                                      {
    std::list<std::string> dbs;
    dbaccessor::dbptr()->get_updated_dbs(dbs);
    return dbs;
}

unsubscribe()

void dbe::confaccessor::unsubscribe ( )

static

Definition at line 442 of file confaccessor.cpp.

{
  if ( dbaccessor::dbptr().get() && ref().CallId != nullptr )
  {
    dbaccessor::dbptr()->unsubscribe ( ref().CallId );
  }
}

Friends And Related Symbol Documentation

dbaccessor

friend class dbaccessor

friend

Definition at line 272 of file confaccessor.hpp.

Member Data Documentation

CallId

dunedaq::conffwk::Configuration::CallbackId dbe::confaccessor::CallId

private

Definition at line 237 of file confaccessor.hpp.

coreconfig

ui::config::info* dbe::confaccessor::coreconfig

private

Definition at line 244 of file confaccessor.hpp.

editconfig

datahandler* dbe::confaccessor::editconfig

private

Definition at line 243 of file confaccessor.hpp.

external_change_stack

t_external_changes_stack dbe::confaccessor::external_change_stack

private

Definition at line 240 of file confaccessor.hpp.

force_mut

t_mutex dbe::confaccessor::force_mut

mutableprivate

Definition at line 250 of file confaccessor.hpp.

IncludedFileCache

QList<QStringList> dbe::confaccessor::IncludedFileCache

private

Definition at line 246 of file confaccessor.hpp.

internal_change_stack

std::shared_ptr<t_internal_changes_stack> dbe::confaccessor::internal_change_stack

private

Definition at line 239 of file confaccessor.hpp.

mut_changes

t_mutex dbe::confaccessor::mut_changes

mutableprivate

Definition at line 249 of file confaccessor.hpp.

sequenced_command_stack

t_undo_stack* dbe::confaccessor::sequenced_command_stack

private

Definition at line 241 of file confaccessor.hpp.

this_change_enabled

bool dbe::confaccessor::this_change_enabled

private

Definition at line 252 of file confaccessor.hpp.

this_change_enabled_mutex

t_mutex dbe::confaccessor::this_change_enabled_mutex

mutableprivate

Definition at line 248 of file confaccessor.hpp.

this_dblocation

QString dbe::confaccessor::this_dblocation

private

Definition at line 234 of file confaccessor.hpp.

this_resource_location

QString dbe::confaccessor::this_resource_location

private

Definition at line 235 of file confaccessor.hpp.

this_total_objects

int dbe::confaccessor::this_total_objects

private

Definition at line 254 of file confaccessor.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/dbe/include/dbe/confaccessor.hpp
• /github/workspace/dunedaq/sourcecode/dbe/src/internal/confaccessor.cpp