dbe::config::api::commands Namespace Reference

Namespaces
namespace	file

Functions
template<class T>
void	modobj (tref Object, dunedaq::conffwk::attribute_t const &AttributeData, T Value)
template<>
void	modobj< std::vector< std::string > > (tref Object, dunedaq::conffwk::attribute_t const &AttributeData, std::vector< std::string > Value)
void	newobj (std::string const &fn, std::string const &class_name, std::string const &UID, dbe::t_config_object_preimage::type_attrmap const &attributes, dbe::t_config_object_preimage::type_relmap const &relations, QUuid const &src)
bool	delobj (inner::configobject::tref obj, QUuid const &src)
bool	renobj (inner::configobject::tref obj, std::string const &newuuid, QUuid const &src)
bool	movobj (inner::configobject::tref obj, std::string const &destination, QUuid const &src)
void	modobj (inner::configobject::tref obj, dunedaq::conffwk::relationship_t const &link, std::vector< std::string > const &others)
template<>
void	modobj< std::string > (tref Object, const dunedaq::conffwk::attribute_t &AttributeData, std::string Value)
template<>
void	modobj< std::vector< std::string > > (tref Object, const dunedaq::conffwk::attribute_t &AttributeData, std::vector< std::string > Value)

Function Documentation

delobj()

bool dbe::config::api::commands::delobj	(	inner::configobject::tref	obj,
		QUuid const &	src )

Create a command that once activated it will delete an object and when undone will recreate the object from the database

emits an object_deleted signal

Parameters

obj	an object copy shadowing the one to be removed from the database
src	is the internal uuid of the object reqesting the change

Returns

false in case of error

Definition at line 79 of file config_api_commands.cpp.

{
  try
  {
    std::string const description
    { "Object deleted : " + obj.UID() + "@" + obj.class_name()
    };
    config_internal_change request
      { config_internal_change::DELETED, description, obj.UID(), obj.class_name(), "" };
    confaccessor::get_commands()->push ( new dbe::actions::object::remove ( obj, src ) );
    confaccessor::get_internal_change_stack()->push ( request );
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    INFO ( "Delete Object: The object could not be deleted!\n\n", dbe::config::errors::parse ( dbe_err ).c_str() );
    return false;
  }
 
  return true;
}

modobj() [1/2]

void dbe::config::api::commands::modobj	(	inner::configobject::tref	obj,
		dunedaq::conffwk::relationship_t const &	link,
		std::vector< std::string > const &	others )

Set a RELATION to new values , causes the Object and the objects designated by the new values to become linked

object -> others[x]

Parameters

object	that holds the outgoing link [ -> ]
link	to set between object that others
others	are the objects to be connected to object

Definition at line 160 of file config_api_commands.cpp.

{
  try
  {
    confaccessor::get_commands()->push (
      new dbe::actions::object::changerefs ( object, linkinfo, others_names ) );
    std::string
    const description (
      others_names.size() != 1 ? "Multi Relationship : " + linkinfo.p_name :
      "Single Relationship : " + linkinfo.p_name );
 
    config_internal_change const change
    {
      config_internal_change::MODIFIED, description, object.UID(), object.class_name(), ""
    };
 
    confaccessor::get_internal_change_stack()->push ( change );
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    WARN ( "The object reference could not be changed", dbe::config::errors::parse ( dbe_err ).c_str() );
  }
}

modobj() [2/2]

template<class T>

void dbe::config::api::commands::modobj	(	inner::configobject::tref	obj,
		dunedaq::conffwk::attribute_t const &	attr,
		T	value )

Set an ATTRIBUTE to a specific value by generating appropriately modification commands

Parameters

obj	to be modified
attr	provides information about the attribute to be modified
value	to be assigned to the new object

Definition at line 115 of file config_api.hpp.

{
  try
  {
    std::string const description = std::string ( "Attribute " ) + AttributeData.p_name;
 
    dbe::config_internal_change Change
    {
      dbe::config_internal_change::MODIFIED,
      description,
      Object.UID(),
      Object.class_name(),
      Object.contained_in() };
 
    confaccessor::get_commands()->push (
      new dbe::actions::ChangeAttribute<T> ( Object, AttributeData, Value ) );
    confaccessor::get_internal_change_stack()->push ( Change );
 
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    WARN ( "The object attribute could not be changed", dbe::config::errors::parse ( dbe_err ).c_str() );
  }
  catch ( dunedaq::conffwk::Exception const & e )
  {
    WARN ( "Change Attribute: The attribute could not be changed",
           dbe::config::errors::parse ( e ).c_str() );
  }
}

modobj< std::string >()

template<>

void dbe::config::api::commands::modobj< std::string >	(	tref	Object,
		const dunedaq::conffwk::attribute_t &	AttributeData,
		std::string	Value )

Definition at line 188 of file config_api_commands.cpp.

{
  try
  {
    config_internal_change Change;
    Change.uid = Object.UID();
    Change.classname = Object.class_name();
    Change.request = config_internal_change::MODIFIED;
    Change.description = QString ( "Attribute " ).append ( AttributeData.p_name.c_str() )
                         .toStdString();
 
    if ( AttributeData.p_type == dunedaq::conffwk::string_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeAttribute<std::string> ( Object, AttributeData, Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::enum_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeEnum<std::string> ( Object, AttributeData, Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::class_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeClass<std::string> ( Object, AttributeData, Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::date_type )
    {
 
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeDate<std::string> ( Object, AttributeData, Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::time_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeTime<std::string> ( Object, AttributeData, Value ) );
    }
 
    confaccessor::get_internal_change_stack()->push ( Change );
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    WARN ( "The object attribute could not be changed", dbe::config::errors::parse ( dbe_err ).c_str() );
  }
}

modobj< std::vector< std::string > >() [1/2]

template<>

void dbe::config::api::commands::modobj< std::vector< std::string > >	(	tref	Object,
		const dunedaq::conffwk::attribute_t &	AttributeData,
		std::vector< std::string >	Value )

Definition at line 238 of file config_api_commands.cpp.

{
  try
  {
    config_internal_change Change;
    Change.uid = Object.UID();
    Change.classname = Object.class_name();
    Change.request = config_internal_change::MODIFIED;
    Change.description = QString ( "Attribute " ).append ( AttributeData.p_name.c_str() )
                         .toStdString();
 
    if ( AttributeData.p_type == dunedaq::conffwk::string_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeAttribute<std::vector<std::string>> ( Object, AttributeData,
                                                                      Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::enum_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeEnum<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::class_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeClass<std::vector<std::string>> ( Object, AttributeData,
                                                                  Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::date_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeDate<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::time_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeTime<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
 
    confaccessor::get_internal_change_stack()->push ( Change );
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    WARN ( "The object attribute could not be changed", dbe::config::errors::parse ( dbe_err ).c_str()  );
  }
}

modobj< std::vector< std::string > >() [2/2]

template<>

void dbe::config::api::commands::modobj< std::vector< std::string > >	(	tref	Object,
		dunedaq::conffwk::attribute_t const &	AttributeData,
		std::vector< std::string >	Value )

Definition at line 238 of file config_api_commands.cpp.

{
  try
  {
    config_internal_change Change;
    Change.uid = Object.UID();
    Change.classname = Object.class_name();
    Change.request = config_internal_change::MODIFIED;
    Change.description = QString ( "Attribute " ).append ( AttributeData.p_name.c_str() )
                         .toStdString();
 
    if ( AttributeData.p_type == dunedaq::conffwk::string_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeAttribute<std::vector<std::string>> ( Object, AttributeData,
                                                                      Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::enum_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeEnum<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::class_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeClass<std::vector<std::string>> ( Object, AttributeData,
                                                                  Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::date_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeDate<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
    else if ( AttributeData.p_type == dunedaq::conffwk::time_type )
    {
      confaccessor::get_commands()->push (
        new dbe::actions::ChangeTime<std::vector<std::string>> ( Object, AttributeData,
                                                                 Value ) );
    }
 
    confaccessor::get_internal_change_stack()->push ( Change );
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    WARN ( "The object attribute could not be changed", dbe::config::errors::parse ( dbe_err ).c_str()  );
  }
}

movobj()

bool dbe::config::api::commands::movobj	(	inner::configobject::tref	obj,
		std::string const &	destination,
		QUuid const &	src )

Creates a command object holding move from current file to new file and undoing capabilities

Parameters

obj	an object copy shadowing the one to be moved
destination	that the object is going to be moved to

Returns

true in case that the move was successful

Definition at line 132 of file config_api_commands.cpp.

{
  try
  {
    std::string const description
    { "Object " + obj.UID() + "@" + obj.class_name() + " contained in " + obj.contained_in()
      + " moved to " + destination
    };
 
    config_internal_change request
      { config_internal_change::MOVED, description, obj.UID(), obj.class_name(), "" };
 
    confaccessor::get_commands()->push (
      new dbe::actions::object::move ( obj, destination, src ) );
    confaccessor::get_internal_change_stack()->push ( request );
 
    return true;
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    INFO ( "It was not possible to move object ", dbe::config::errors::parse ( dbe_err ).c_str(), "\n\nObject UID:",
           obj.UID().c_str() );
    return false;
  }
}

newobj()

void dbe::config::api::commands::newobj	(	std::string const &	fn,
		std::string const &	class_name,
		std::string const &	UID,
		dbe::t_config_object_preimage::type_attrmap const &	attributes,
		dbe::t_config_object_preimage::type_relmap const &	relations,
		QUuid const &	src )

Create a command that once activated will create an object and when undone it will remove the object from the database

emits an object_created signal

Parameters

fn	is the file where it should be created
class_name	is the class it belongs to
UID	of the new UID of the object to be created
attributes	is the attribute map
relations	is the relational map

Definition at line 61 of file config_api_commands.cpp.

{
  std::string description
  { "Object created : " + name + "@" + cn };
 
  config_internal_change request
    { config_internal_change::CREATED, description, name, cn, "" };
 
  confaccessor::get_commands()->push (
    new dbe::actions::object::create ( { attributes, relations, { name, cn}, fn }, src ) );
 
  confaccessor::get_internal_change_stack()->push ( request );
}

renobj()

bool dbe::config::api::commands::renobj	(	inner::configobject::tref	obj,
		std::string const &	newuuid,
		QUuid const &	src )

Create a command that once activated will rename an object and when undone the object will be renamed to its old name.

emits an object_deleted signal

Parameters

obj	an object copy shadowing the one to be removed from the database
newuuid	is the unique name assigned to the object

Returns

false in case of error

Definition at line 102 of file config_api_commands.cpp.

{
  try
  {
    std::string const description =
    {
      "Object renamed : " + obj.UID() + "@" + obj.class_name() + " to " + newuuid + "@"
      + obj.class_name()
    };
 
    config_internal_change request
      { config_internal_change::RENAMED, description, obj.UID(), obj.class_name(), "" };
 
    confaccessor::get_commands()->push (
      new dbe::actions::object::rename ( obj, newuuid, src ) );
 
    confaccessor::get_internal_change_stack()->push ( request );
 
    return true;
  }
  catch ( daq::dbe::ObjectChangeWasNotSuccessful const & dbe_err )
  {
    INFO ( "It was not possible to rename object ", dbe::config::errors::parse ( dbe_err ).c_str(), "\n\nObject UID:",
           obj.UID().c_str() );
    return false;
  }
}