dunedaq::oksconflibs::OksConfigObject Class Reference

#include <OksConfigObject.hpp>

Inheritance diagram for dunedaq::oksconflibs::OksConfigObject:

Collaboration diagram for dunedaq::oksconflibs::OksConfigObject:

Public Member Functions
	OksConfigObject (oks::OksObject *obj, conffwk::ConfigurationImpl *impl) noexcept
virtual	~OksConfigObject () noexcept
virtual const std::string	contained_in () const
	Virtual method to get object's database file name.
virtual void	get (const std::string &name, bool &value)
	Virtual method to read boolean attribute value.
virtual void	get (const std::string &name, uint8_t &value)
	Virtual method to read unsigned char attribute value.
virtual void	get (const std::string &name, int8_t &value)
	Virtual method to read signed char attribute value.
virtual void	get (const std::string &name, uint16_t &value)
	Virtual method to read unsigned short attribute value.
virtual void	get (const std::string &name, int16_t &value)
	Virtual method to read signed short attribute value.
virtual void	get (const std::string &name, uint32_t &value)
	Virtual method to read unsigned long attribute value.
virtual void	get (const std::string &name, int32_t &value)
	Virtual method to read signed long attribute value.
virtual void	get (const std::string &name, uint64_t &value)
	Virtual method to read unsigned 64 bits integer attribute value.
virtual void	get (const std::string &name, int64_t &value)
	Virtual method to read signed 64 bits integer attribute value.
virtual void	get (const std::string &name, float &value)
	Virtual method to read float attribute value.
virtual void	get (const std::string &name, double &value)
	Virtual method to read double attribute value.
virtual void	get (const std::string &name, std::string &value)
	Virtual method to read string attribute value.
virtual void	get (const std::string &name, conffwk::ConfigObject &value)
	Virtual method to read relationship single-value.
virtual void	get (const std::string &name, std::vector< bool > &value)
	Virtual method to read vector-of-booleans attribute value.
virtual void	get (const std::string &name, std::vector< uint8_t > &value)
	Virtual method to read vector-of-unsigned-chars attribute value.
virtual void	get (const std::string &name, std::vector< int8_t > &value)
	Virtual method to read vector-of-signed-chars attribute value.
virtual void	get (const std::string &name, std::vector< uint16_t > &value)
	Virtual method to read vector-of-unsigned-shorts attribute value.
virtual void	get (const std::string &name, std::vector< int16_t > &value)
	Virtual method to read vector-of-signed-shorts attribute value.
virtual void	get (const std::string &name, std::vector< uint32_t > &value)
	Virtual method to read vector-of-unsigned-longs attribute value.
virtual void	get (const std::string &name, std::vector< int32_t > &value)
	Virtual method to read vector-of-signed-longs attribute value.
virtual void	get (const std::string &name, std::vector< uint64_t > &value)
	Virtual method to read vector-of-unsigned-64-bits-integers attribute value.
virtual void	get (const std::string &name, std::vector< int64_t > &value)
	Virtual method to read vector-of-signed-64-bits-integers attribute value.
virtual void	get (const std::string &name, std::vector< float > &value)
	Virtual method to read vector-of-floats attribute value.
virtual void	get (const std::string &name, std::vector< double > &value)
	Virtual method to read vector-of-doubles attribute value.
virtual void	get (const std::string &name, std::vector< std::string > &value)
	Virtual method to read vector-of-strings attribute value.
virtual void	get (const std::string &name, std::vector< conffwk::ConfigObject > &value)
virtual bool	rel (const std::string &name, std::vector< conffwk::ConfigObject > &value)
virtual void	referenced_by (std::vector< conffwk::ConfigObject > &value, const std::string &association, bool check_composite_only, unsigned long rlevel, const std::vector< std::string > *rclasses) const
virtual void	set (const std::string &name, bool value)
	Virtual method to set boolean attribute value.
virtual void	set (const std::string &name, uint8_t value)
	Virtual method to set unsigned char attribute value.
virtual void	set (const std::string &name, int8_t value)
	Virtual method to set signed char attribute value.
virtual void	set (const std::string &name, uint16_t value)
	Virtual method to set unsigned short attribute value.
virtual void	set (const std::string &name, int16_t value)
	Virtual method to set signed short attribute value.
virtual void	set (const std::string &name, uint32_t value)
	Virtual method to set unsigned long attribute value.
virtual void	set (const std::string &name, int32_t value)
	Virtual method to set signed long attribute value.
virtual void	set (const std::string &name, uint64_t value)
	Virtual method to set unsigned 64 bits integer attribute value.
virtual void	set (const std::string &name, int64_t value)
	Virtual method to set signed 64 bits integer attribute value.
virtual void	set (const std::string &name, float value)
	Virtual method to set float attribute value.
virtual void	set (const std::string &name, double value)
	Virtual method to set double attribute value.
virtual void	set (const std::string &name, const std::string &value)
	Virtual method to set string attribute value.
virtual void	set_enum (const std::string &attribute, const std::string &value)
	Virtual method to set enumeration attribute value.
virtual void	set_date (const std::string &attribute, const std::string &value)
	Virtual method to set date attribute value.
virtual void	set_time (const std::string &attribute, const std::string &value)
	Virtual method to set time attribute value.
virtual void	set_class (const std::string &attribute, const std::string &value)
	Virtual method to set enumeration attribute value.
virtual void	set (const std::string &name, const std::vector< bool > &value)
	Virtual method to read vector-of-booleans attribute value.
virtual void	set (const std::string &name, const std::vector< uint8_t > &value)
	Virtual method to read vector-of-unsigned-chars attribute value.
virtual void	set (const std::string &name, const std::vector< int8_t > &value)
	Virtual method to read vector-of-signed-chars attribute value.
virtual void	set (const std::string &name, const std::vector< uint16_t > &value)
	Virtual method to read vector-of-unsigned-shorts attribute value.
virtual void	set (const std::string &name, const std::vector< int16_t > &value)
	Virtual method to read vector-of-signed-shorts attribute value.
virtual void	set (const std::string &name, const std::vector< uint32_t > &value)
	Virtual method to read vector-of-unsigned-longs attribute value.
virtual void	set (const std::string &name, const std::vector< int32_t > &value)
	Virtual method to read vector-of-signed-longs attribute value.
virtual void	set (const std::string &name, const std::vector< uint64_t > &value)
	Virtual method to read vector-of-unsigned-64-bits-integers attribute value.
virtual void	set (const std::string &name, const std::vector< int64_t > &value)
	Virtual method to read vector-of-signed-64-bits-integers attribute value.
virtual void	set (const std::string &name, const std::vector< float > &value)
	Virtual method to read vector-of-floats attribute value.
virtual void	set (const std::string &name, const std::vector< double > &value)
	Virtual method to read vector-of-doubles attribute value.
virtual void	set (const std::string &name, const std::vector< std::string > &value)
	Virtual method to read vector-of-strings attribute value.
virtual void	set_enum (const std::string &attribute, const std::vector< std::string > &value)
	Virtual method to read vector-of-enumerations attribute value.
virtual void	set_date (const std::string &attribute, const std::vector< std::string > &value)
	Virtual method to read vector-of-dates attribute value.
virtual void	set_time (const std::string &attribute, const std::vector< std::string > &value)
	Virtual method to read vector-of-times attribute value.
virtual void	set_class (const std::string &attribute, const std::vector< std::string > &value)
	Virtual method to read vector-of-enumerations attribute value.
virtual void	set (const std::string &name, const conffwk::ConfigObject *value, bool skip_non_null_check)
	Virtual method to read conffwk-object relationship value.
virtual void	set (const std::string &name, const std::vector< const conffwk::ConfigObject * > &value, bool skip_non_null_check)
virtual void	move (const std::string &at)
	Virtual method to move object to a file.
virtual void	rename (const std::string &new_id)
	Virtual method to change object ID.
virtual void	reset ()
	Virtual method to reset the implementation object from unknown state.
oks::OksData::Type	get_type (const std::string &attribute) const
void	set (oks::OksObject *obj)
Public Member Functions inherited from dunedaq::conffwk::ConfigObjectImpl
	ConfigObjectImpl (ConfigurationImpl *impl, const std::string &id, dunedaq::conffwk::ObjectState state=dunedaq::conffwk::Valid) noexcept
	The constructor stores configuration implementation pointer.
virtual	~ConfigObjectImpl () noexcept
	The virtual destructor.
const std::string &	UID () const noexcept
	Method to get database object's unique ID.
const std::string &	class_name () const noexcept
	Virtual method to get object's class name.
virtual void	get (const std::string &association, std::vector< ConfigObject > &value)=0
	Virtual method to read vector-of-conffwk-objects relationship value.
virtual bool	rel (const std::string &name, std::vector< ConfigObject > &value)=0
	Virtual method to read any relationship value without throwing an exception if there is no such relationship (return false).
virtual void	referenced_by (std::vector< ConfigObject > &value, const std::string &association, bool check_composite_only, unsigned long rlevel, const std::vector< std::string > *rclasses) const =0
	Virtual method to read vector-of-conffwk-object referencing this object.
virtual void	set (const std::string &association, const std::vector< const ConfigObject * > &value, bool skip_non_null_check)=0
	Virtual method to read vector-of-conffwk-objects relationship value.
virtual void	clear () noexcept
	Virtual method to clean resources used by the implementation object.
bool	is_deleted () const
	Check object and return true if the object has been deleted.

Private Member Functions
template<class T>
void	get_value (const std::string &name, T &value)
template<class T>
void	get_vector (const std::string &name, std::vector< T > &value)
void	set_attr_value (const std::string &name, oks::OksData &value)
void	set_rel_value (const std::string &name, oks::OksData &value, bool skip_non_null_check)
template<class T>
void	set_value (const std::string &name, const T &value)
template<class T>
void	set_vector (const std::string &name, const std::vector< T > &value)

Private Attributes
oks::OksObject *	m_obj

Friends
class	ConfigurationImpl
class	OksConfiguration

Additional Inherited Members
Static Public Member Functions inherited from dunedaq::conffwk::ConfigObjectImpl
static ConfigObjectImpl *	default_impl () noexcept
	Returns default implementation.
Protected Member Functions inherited from dunedaq::conffwk::ConfigObjectImpl
void	throw_if_deleted () const
Protected Attributes inherited from dunedaq::conffwk::ConfigObjectImpl
ConfigurationImpl *	m_impl
dunedaq::conffwk::ObjectState	m_state
std::string	m_id
const std::string *	m_class_name
std::mutex	m_mutex

Detailed Description

Definition at line 26 of file OksConfigObject.hpp.

Constructor & Destructor Documentation

OksConfigObject()

OksConfigObject::OksConfigObject ( oks::OksObject * obj, conffwk::ConfigurationImpl * impl )

noexcept

Definition at line 114 of file OksConfigObject.cpp.

                                                                                                :
  ConfigObjectImpl (impl, obj->GetId()),
  m_obj            (obj)
{
}

~OksConfigObject()

OksConfigObject::~OksConfigObject ( )

virtualnoexcept

Definition at line 120 of file OksConfigObject.cpp.

{
}

Member Function Documentation

contained_in()

const std::string OksConfigObject::contained_in ( ) const

virtual

Virtual method to get object's database file name.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 125 of file OksConfigObject.cpp.

{
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
  throw_if_deleted();
  return m_obj->get_file()->get_full_file_name();
}

get() [1/26]

void OksConfigObject::get ( const std::string & attribute, bool & value )

virtual

Virtual method to read boolean attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 133 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [2/26]

void OksConfigObject::get ( const std::string & association, conffwk::ConfigObject & value )

virtual

Virtual method to read relationship single-value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 239 of file OksConfigObject.cpp.

{
  OksData * data = 0;
 
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
      data = m_obj->GetRelationshipValue(name);
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("relationship", name, m_obj).c_str(), ex);
    }
 
  if (data->type != OksData::object_type)
    {
      if (data->type == OksData::uid_type || data->type == OksData::uid2_type)
        {
          std::ostringstream text;
          text << "referenced object " << *data << " is not loaded";
          throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("relationship", name, m_obj, text.str().c_str()).c_str());
        }
 
      std::ostringstream text;
      text << "bad value of relationship \"" << name << "\" of object " << m_obj << ": ";
 
      if(data->type == OksData::list_type)
        {
          text << "the relationship is multi-value";
        }
      else
        {
          text << "non-object type was read";
        }
      throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
    }
 
  if (data->data.OBJECT != nullptr)
    {
      value = static_cast<OksConfiguration *>(m_impl)->new_object(data->data.OBJECT);
    }
  else
    {
      value = nullptr;
    }
}

get() [3/26]

void OksConfigObject::get ( const std::string & attribute, double & value )

virtual

Virtual method to read double attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 193 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [4/26]

void OksConfigObject::get ( const std::string & attribute, float & value )

virtual

Virtual method to read float attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 187 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [5/26]

void OksConfigObject::get ( const std::string & attribute, int16_t & value )

virtual

Virtual method to read signed short attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 157 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [6/26]

void OksConfigObject::get ( const std::string & attribute, int32_t & value )

virtual

Virtual method to read signed long attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 169 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [7/26]

void OksConfigObject::get ( const std::string & attribute, int64_t & value )

virtual

Virtual method to read signed 64 bits integer attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 181 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [8/26]

void OksConfigObject::get ( const std::string & attribute, int8_t & value )

virtual

Virtual method to read signed char attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 145 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [9/26]

void OksConfigObject::get ( const std::string & attribute, std::string & value )

virtual

Virtual method to read string attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 199 of file OksConfigObject.cpp.

{
  OksData * data = 0;
 
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
      data = m_obj->GetAttributeValue(name);
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic( ERS_HERE, mk_get_error_text("attribute", name, m_obj).c_str(), ex);
    }
 
  if ((data->type == OksData::string_type) || (data->type == OksData::enum_type))
    {
      value = *data->data.STRING;
      return;
    }
  else if (data->type == OksData::date_type || data->type == OksData::time_type)
    {
      value = data->str();
      return;
    }
  else if (data->type == OksData::class_type)
    {
      value = data->data.CLASS->get_name();
      return;
    }
  else
    {
      std::ostringstream text;
      text << "read wrong attribute type instead of expected \'string\' for attribute \"" << name << "\" of object " << m_obj;
      throw dunedaq::conffwk::Generic( ERS_HERE, text.str().c_str() );
    }
}

get() [10/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< bool > & value )

virtual

Virtual method to read vector-of-booleans attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 289 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [11/26]

virtual void dunedaq::oksconflibs::OksConfigObject::get ( const std::string & name, std::vector< conffwk::ConfigObject > & value )

virtual

get() [12/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< double > & value )

virtual

Virtual method to read vector-of-doubles attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 349 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [13/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< float > & value )

virtual

Virtual method to read vector-of-floats attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 343 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [14/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< int16_t > & value )

virtual

Virtual method to read vector-of-signed-shorts attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 313 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [15/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< int32_t > & value )

virtual

Virtual method to read vector-of-signed-longs attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 325 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [16/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< int64_t > & value )

virtual

Virtual method to read vector-of-signed-64-bits-integers attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 337 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [17/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< int8_t > & value )

virtual

Virtual method to read vector-of-signed-chars attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 301 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [18/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< std::string > & value )

virtual

Virtual method to read vector-of-strings attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 355 of file OksConfigObject.cpp.

{
  OksData * data = 0;
 
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
      data = m_obj->GetAttributeValue(name);
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("attribute", name, m_obj).c_str(), ex);
    }
 
  if (data->type != OksData::list_type)
    {
      std::ostringstream text;
      text << "attribute \"" << name << "\" of object " << m_obj << " is not of a multi-value";
      throw dunedaq::conffwk::Generic( ERS_HERE, text.str().c_str());
    }
 
  value.clear();
 
  for (const auto & it : *data->data.LIST)
    {
      if ((it->type == OksData::string_type) || (it->type == OksData::enum_type))
        {
          value.emplace_back(*it->data.STRING);
        }
      else if (it->type == OksData::class_type)
        {
          value.emplace_back(it->data.CLASS->get_name());
        }
      else if (it->type == OksData::date_type || it->type == OksData::time_type)
        {
          value.emplace_back(it->str());
        }
      else
        {
          std::ostringstream text;
          text << "wrong type of attribute \"" << name << "\" of object " << m_obj << " (instead of expected string)";
          throw dunedaq::conffwk::Generic( ERS_HERE, text.str().c_str() );
        }
    }
}

get() [19/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< uint16_t > & value )

virtual

Virtual method to read vector-of-unsigned-shorts attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 307 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [20/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< uint32_t > & value )

virtual

Virtual method to read vector-of-unsigned-longs attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 319 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [21/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< uint64_t > & value )

virtual

Virtual method to read vector-of-unsigned-64-bits-integers attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 331 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [22/26]

void OksConfigObject::get ( const std::string & attribute, std::vector< uint8_t > & value )

virtual

Virtual method to read vector-of-unsigned-chars attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 295 of file OksConfigObject.cpp.

{
  get_vector(name, value);
}

get() [23/26]

void OksConfigObject::get ( const std::string & attribute, uint16_t & value )

virtual

Virtual method to read unsigned short attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 151 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [24/26]

void OksConfigObject::get ( const std::string & attribute, uint32_t & value )

virtual

Virtual method to read unsigned long attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 163 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [25/26]

void OksConfigObject::get ( const std::string & attribute, uint64_t & value )

virtual

Virtual method to read unsigned 64 bits integer attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 175 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get() [26/26]

void OksConfigObject::get ( const std::string & attribute, uint8_t & value )

virtual

Virtual method to read unsigned char attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 139 of file OksConfigObject.cpp.

{
  get_value(name, value);
}

get_type()

OksData::Type OksConfigObject::get_type

(

const std::string &

attribute

)

const

Definition at line 48 of file OksConfigObject.cpp.

{
  try
    {
      return m_obj->GetAttributeValue(name)->type;
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("attribute", name, m_obj).c_str(), ex);
    }
}

get_value()

template<class T>

void OksConfigObject::get_value ( const std::string & name, T & value )

private

Definition at line 63 of file OksConfigObject.cpp.

  {
    std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
    try
      {
        throw_if_deleted();
        OksData * data(m_obj->GetAttributeValue(name));
        value = *reinterpret_cast<T*>(&data->data); // really ugly stuff here, but should come out right
      }
    catch (oks::exception& ex)
      {
        throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("attribute", name, m_obj).c_str(), ex);
      }
  }

get_vector()

template<class T>

void OksConfigObject::get_vector ( const std::string & name, std::vector< T > & value )

private

Definition at line 83 of file OksConfigObject.cpp.

  {
    OksData * data = 0;
 
    std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
    try
      {
        throw_if_deleted();
        data = m_obj->GetAttributeValue(name);
      }
    catch (oks::exception& ex)
      {
        throw dunedaq::conffwk::Generic( ERS_HERE, mk_get_error_text("attribute", name, m_obj).c_str(), ex);
      }
 
    if (data->type != OksData::list_type)
      {
        std::ostringstream text;
        text << "attribute \"" << name << "\" of object " << m_obj << " is not of a multi-value";
        throw dunedaq::conffwk::Generic( ERS_HERE, text.str().c_str() );
      }
 
    value.clear();
    for (const auto& it : *data->data.LIST)
      {
        value.push_back(*reinterpret_cast<T*>(&it->data));
      }
  }

move()

void OksConfigObject::move ( const std::string & at )

virtual

Virtual method to move object to a file.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 980 of file OksConfigObject.cpp.

{
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  throw_if_deleted();
 
  if (OksFile * new_file_h = m_obj->GetClass()->get_kernel()->find_data_file(at))
    {
      OksFile * old_file_h = m_obj->get_file();
      if (old_file_h != new_file_h)
        {
          try
            {
//              static_cast<OksConfiguration *>(m_impl)->test_and_checkout(old_file_h);
//              static_cast<OksConfiguration *>(m_impl)->test_and_checkout(new_file_h);
              m_obj->set_file(new_file_h, false);
            }
          catch (oks::exception& ex)
            {
              throw dunedaq::conffwk::Generic(ERS_HERE, ex.what());
            }
        }
    }
  else
    {
      std::ostringstream text;
      text << "file \"" << at << "\" is not loaded";
      throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
    }
}

referenced_by()

void OksConfigObject::referenced_by ( std::vector< conffwk::ConfigObject > & value, const std::string & association, bool check_composite_only, unsigned long rlevel, const std::vector< std::string > * rclasses ) const

virtual

Definition at line 493 of file OksConfigObject.cpp.

{
  value.clear();
 
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
  throw_if_deleted();
 
  if (check_composite_only)
    {
      bool any_name = (rname == "*");
 
      if (const std::list<OksRCR *> * rcr = m_obj->reverse_composite_rels())
        {
          for (const auto& i : *rcr)
            {
              if (any_name || rname == i->relationship->get_name())
                {
                  value.push_back(conffwk::ConfigObject(static_cast<OksConfiguration *>(m_impl)->new_object(i->obj)));
                }
            }
        }
    }
  else
    {
      if (OksObject::FList * objs = m_obj->get_all_rels(rname))
        {
          for (const auto& i : *objs)
            {
              value.push_back(conffwk::ConfigObject(static_cast<OksConfiguration *>(m_impl)->new_object(i)));
            }
 
          delete objs;
        }
    }
}

rel()

bool OksConfigObject::rel ( const std::string & name, std::vector< conffwk::ConfigObject > & value )

virtual

Definition at line 448 of file OksConfigObject.cpp.

{
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
 
      if (OksDataInfo * di = m_obj->GetClass()->get_data_info(name))
        {
          if (di->relationship)
            {
              OksData * data = m_obj->GetRelationshipValue(di);
 
              if (data->type == OksData::object_type)
                {
                  if (data->data.OBJECT != nullptr)
                    {
                      value.push_back(conffwk::ConfigObject(static_cast<OksConfiguration *>(m_impl)->new_object(data->data.OBJECT)));
                    }
                }
              else if (data->type == OksData::list_type)
                {
                  for (const auto& it : *data->data.LIST)
                    {
                      if (it->type == OksData::object_type)
                        {
                          value.push_back(conffwk::ConfigObject(static_cast<OksConfiguration *>(m_impl)->new_object(it->data.OBJECT)));
                        }
                    }
                }
 
              return true;
            }
        }
 
      return false;
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_get_error_text("relationship", name, m_obj).c_str(), ex);
    }
}

rename()

void OksConfigObject::rename ( const std::string & new_id )

virtual

Virtual method to change object ID.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 1013 of file OksConfigObject.cpp.

{
  try
    {
      throw_if_deleted();
 
//      std::set<OksFile *> files;
//
//      files.insert(m_obj->get_file());
//
//      if (OksObject::FList * objs = m_obj->get_all_rels())
//        {
//          for (auto & f : *objs)
//            {
//              files.insert(f->get_file());
//            }
//
//          delete objs;
//        }
//
//      for (auto & f : files)
//        {
//          static_cast<OksConfiguration *>(m_impl)->test_and_checkout(f);
//        }
 
      m_obj->set_id(new_id);
    }
  catch (oks::exception& ex)
    {
      std::ostringstream text;
      text << "cannot rename object " << m_obj << " to new name \'" << new_id << "\' because " << ex.what();
      throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
    }
}

reset()

void OksConfigObject::reset ( )

virtual

Virtual method to reset the implementation object from unknown state.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 1049 of file OksConfigObject.cpp.

{
  if (OksClass * c = static_cast<OksConfiguration *>(m_impl)->m_kernel->find_class(*m_class_name))
    {
      m_obj = c->get_object(m_id);
    }
  else
    {
      m_obj = nullptr;
    }
 
  m_state = (m_obj ? dunedaq::conffwk::Valid : dunedaq::conffwk::Deleted);
}

set() [1/27]

void OksConfigObject::set ( const std::string & attribute, bool value )

virtual

Virtual method to set boolean attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 601 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [2/27]

void OksConfigObject::set ( const std::string & association, const conffwk::ConfigObject * value, bool skip_non_null_check )

virtual

Virtual method to read conffwk-object relationship value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 955 of file OksConfigObject.cpp.

{
  OksData d((value != nullptr) ? static_cast<const OksConfigObject*>(value->implementation())->m_obj : (OksObject *) nullptr);
  set_rel_value(name, d, skip_non_null_check);
}

set() [3/27]

void OksConfigObject::set ( const std::string & attribute, const std::string & value )

virtual

Virtual method to set string attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 656 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [4/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< bool > & value )

virtual

Virtual method to read vector-of-booleans attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 761 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [5/27]

void OksConfigObject::set ( const std::string & name, const std::vector< const conffwk::ConfigObject * > & value, bool skip_non_null_check )

virtual

Definition at line 962 of file OksConfigObject.cpp.

{
  OksData d(new OksData::List());
 
  for (const auto& i : value)
    {
      d.data.LIST->push_back(new OksData(static_cast<const OksConfigObject*>(i->implementation())->m_obj));
    }
 
  set_rel_value(name, d, skip_non_null_check);
}

set() [6/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< double > & value )

virtual

Virtual method to read vector-of-doubles attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 821 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [7/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< float > & value )

virtual

Virtual method to read vector-of-floats attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 815 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [8/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< int16_t > & value )

virtual

Virtual method to read vector-of-signed-shorts attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 785 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [9/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< int32_t > & value )

virtual

Virtual method to read vector-of-signed-longs attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 797 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [10/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< int64_t > & value )

virtual

Virtual method to read vector-of-signed-64-bits-integers attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 809 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [11/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< int8_t > & value )

virtual

Virtual method to read vector-of-signed-chars attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 773 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [12/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< std::string > & value )

virtual

Virtual method to read vector-of-strings attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 827 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [13/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< uint16_t > & value )

virtual

Virtual method to read vector-of-unsigned-shorts attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 779 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [14/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< uint32_t > & value )

virtual

Virtual method to read vector-of-unsigned-longs attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 791 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [15/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< uint64_t > & value )

virtual

Virtual method to read vector-of-unsigned-64-bits-integers attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 803 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [16/27]

void OksConfigObject::set ( const std::string & attribute, const std::vector< uint8_t > & value )

virtual

Virtual method to read vector-of-unsigned-chars attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 767 of file OksConfigObject.cpp.

{
  set_vector(name, value);
}

set() [17/27]

void OksConfigObject::set ( const std::string & attribute, double value )

virtual

Virtual method to set double attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 651 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [18/27]

void OksConfigObject::set ( const std::string & attribute, float value )

virtual

Virtual method to set float attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 646 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [19/27]

void OksConfigObject::set ( const std::string & attribute, int16_t value )

virtual

Virtual method to set signed short attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 621 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [20/27]

void OksConfigObject::set ( const std::string & attribute, int32_t value )

virtual

Virtual method to set signed long attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 631 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [21/27]

void OksConfigObject::set ( const std::string & attribute, int64_t value )

virtual

Virtual method to set signed 64 bits integer attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 641 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [22/27]

void OksConfigObject::set ( const std::string & attribute, int8_t value )

virtual

Virtual method to set signed char attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 611 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [23/27]

void OksConfigObject::set ( const std::string & attribute, uint16_t value )

virtual

Virtual method to set unsigned short attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 616 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [24/27]

void OksConfigObject::set ( const std::string & attribute, uint32_t value )

virtual

Virtual method to set unsigned long attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 626 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [25/27]

void OksConfigObject::set ( const std::string & attribute, uint64_t value )

virtual

Virtual method to set unsigned 64 bits integer attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 636 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [26/27]

void OksConfigObject::set ( const std::string & attribute, uint8_t value )

virtual

Virtual method to set unsigned char attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 606 of file OksConfigObject.cpp.

{
  set_value(name, value);
}

set() [27/27]

void dunedaq::oksconflibs::OksConfigObject::set ( oks::OksObject * obj )

inline

Definition at line 151 of file OksConfigObject.hpp.

      {
        m_obj = obj;
      }

set_attr_value()

void OksConfigObject::set_attr_value ( const std::string & name, oks::OksData & value )

private

Definition at line 536 of file OksConfigObject.cpp.

{
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
      //test_checkout_needs();
      m_obj->SetAttributeValue(name, &data);
    }
  catch (dunedaq::conffwk::Generic& ex)
    {
      throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
    }
  catch(oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
    }
}

set_class() [1/2]

void OksConfigObject::set_class ( const std::string & attribute, const std::string & value )

virtual

Virtual method to set enumeration attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 691 of file OksConfigObject.cpp.

{
  OksData d;
 
  d.data.CLASS = nullptr;
  d.type = OksData::class_type;
 
    // try to find any attribute in this class; throw exception "no such attribute", if the class has no attributes at all
    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      throw_if_deleted();
 
      const std::list<OksAttribute *> * attrs = m_obj->GetClass()->all_attributes();
 
      if (!attrs || attrs->empty())
        {
          throw dunedaq::conffwk::Generic(ERS_HERE, mk_set_error_text("attribute", name, m_obj, "no such attribute").c_str());
        }
 
      try
        {
          d.SetValue(value.c_str(), attrs->front());
        }
      catch (oks::exception & ex)
        {
          throw dunedaq::conffwk::Generic(ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
        }
    }
 
  set_attr_value(name, d);
}

set_class() [2/2]

void OksConfigObject::set_class ( const std::string & attribute, const std::vector< std::string > & value )

virtual

Virtual method to read vector-of-enumerations attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 869 of file OksConfigObject.cpp.

{
  OksData d(new OksData::List());
 
  // try to find any attribute in this class; throw exception "no such attribute", if the class has no attributes at all
 
    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      throw_if_deleted();
 
      const std::list<OksAttribute *> * attrs = m_obj->GetClass()->all_attributes();
 
      if (!attrs || attrs->empty())
        {
          throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj, "no such attribute").c_str());
        }
 
      for (const auto& i : value)
        {
          OksData * d2 = new OksData();
          d2->data.CLASS = 0;
          d2->type = OksData::class_type;
 
          try
            {
              d2->SetValue(i.c_str(), attrs->front());
            }
          catch (oks::exception & ex)
            {
              throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
            }
 
          d.data.LIST->push_back(d2);
        }
    }
 
  set_attr_value(name, d);
}

set_date() [1/2]

void OksConfigObject::set_date ( const std::string & attribute, const std::string & value )

virtual

Virtual method to set date attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 724 of file OksConfigObject.cpp.

{
  OksData d;
  d.type = OksData::date_type;
 
  try
    {
      d.SetValue(value.c_str(), nullptr);
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
    }
 
  set_attr_value(name, d);
}

set_date() [2/2]

void OksConfigObject::set_date ( const std::string & attribute, const std::vector< std::string > & value )

virtual

Virtual method to read vector-of-dates attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 909 of file OksConfigObject.cpp.

{
  OksData d(new OksData::List());
 
  for (const auto& i : value)
    {
      OksData * d2 = new OksData();
      d2->type = OksData::date_type;
      try
        {
          d2->SetValue(i.c_str(), nullptr);
        }
      catch (oks::exception& ex)
        {
          throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
        }
      d.data.LIST->push_back(d2);
    }
 
  set_attr_value(name, d);
}

set_enum() [1/2]

void OksConfigObject::set_enum ( const std::string & attribute, const std::string & value )

virtual

Virtual method to set enumeration attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 662 of file OksConfigObject.cpp.

{
  OksData d;
 
    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      throw_if_deleted();
 
      if (OksAttribute * a = m_obj->GetClass()->find_attribute(name))
        {
          try
            {
              d.data.ENUMERATION = a->get_enum_value(value);
              d.type = OksData::enum_type;
            }
          catch (std::exception& ex)
            {
              throw(dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj, ex.what()).c_str()) );
            }
        }
      else
        {
          throw ( dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj, "no such attribute").c_str()) );
        }
    }
 
  set_attr_value(name, d);
}

set_enum() [2/2]

void OksConfigObject::set_enum ( const std::string & attribute, const std::vector< std::string > & value )

virtual

Virtual method to read vector-of-enumerations attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 833 of file OksConfigObject.cpp.

{
  OksData d(new OksData::List());
 
    {
      std::lock_guard<std::mutex> scoped_lock(m_mutex);
      throw_if_deleted();
 
      if (OksAttribute * a = m_obj->GetClass()->find_attribute(name))
        {
          for (const auto& i : value)
            {
              OksData * d2 = new OksData();
              try
                {
                  d2->data.ENUMERATION = a->get_enum_value(i); // new OksString(i);
                  d2->type = OksData::enum_type;
                  d.data.LIST->push_back(d2);
                }
              catch (std::exception& ex)
                {
                  throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
                }
 
            }
        }
      else
        {
          throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj, "no such attribute").c_str());
        }
    }
 
  set_attr_value(name, d);
}

set_rel_value()

void OksConfigObject::set_rel_value ( const std::string & name, oks::OksData & value, bool skip_non_null_check )

private

Definition at line 557 of file OksConfigObject.cpp.

{
  std::lock_guard<std::mutex> scoped_lock(m_mutex);
 
  try
    {
      throw_if_deleted();
      //test_checkout_needs();
      m_obj->SetRelationshipValue(name, &data, skip_non_null_check);
    }
  catch (dunedaq::conffwk::Generic& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_set_error_text("relationship", name, m_obj).c_str(), ex );
    }
  catch(oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic(ERS_HERE, mk_set_error_text("relationship", name, m_obj).c_str(), ex);
    }
}

set_time() [1/2]

void OksConfigObject::set_time ( const std::string & attribute, const std::string & value )

virtual

Virtual method to set time attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 742 of file OksConfigObject.cpp.

{
  OksData d;
  d.type = OksData::time_type;
 
  try
    {
      d.SetValue(value.c_str(), nullptr);
    }
  catch (oks::exception& ex)
    {
      throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
    }
 
  set_attr_value(name, d);
}

set_time() [2/2]

void OksConfigObject::set_time ( const std::string & attribute, const std::vector< std::string > & value )

virtual

Virtual method to read vector-of-times attribute value.

Implements dunedaq::conffwk::ConfigObjectImpl.

Definition at line 932 of file OksConfigObject.cpp.

{
  OksData d(new OksData::List());
 
  for (const auto& i : value)
    {
      OksData * d2 = new OksData();
      d2->type = OksData::time_type;
      try
        {
          d2->SetValue(i.c_str(), 0);
        }
      catch (oks::exception& ex)
        {
          throw dunedaq::conffwk::Generic( ERS_HERE, mk_set_error_text("attribute", name, m_obj).c_str(), ex);
        }
      d.data.LIST->push_back(d2);
    }
 
  set_attr_value(name, d);
}

set_value()

template<class T>

void OksConfigObject::set_value ( const std::string & name, const T & value )

private

Definition at line 580 of file OksConfigObject.cpp.

  {
    OksData d(value);
    set_attr_value(name, d);
  }

set_vector()

template<class T>

void OksConfigObject::set_vector ( const std::string & name, const std::vector< T > & value )

private

Definition at line 588 of file OksConfigObject.cpp.

  {
    OksData d(new OksData::List());
 
    for (const auto& i : value)
      {
        d.data.LIST->push_back(new OksData(i));
      }
 
    set_attr_value(name, d);
  }

Friends And Related Symbol Documentation

ConfigurationImpl

friend class ConfigurationImpl

friend

Definition at line 28 of file OksConfigObject.hpp.

OksConfiguration

friend class OksConfiguration

friend

Definition at line 29 of file OksConfigObject.hpp.

Member Data Documentation

m_obj

oks::OksObject* dunedaq::oksconflibs::OksConfigObject::m_obj

private

Definition at line 160 of file OksConfigObject.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/oksconflibs/include/oksconflibs/OksConfigObject.hpp
• /github/workspace/dunedaq/sourcecode/oksconflibs/src/OksConfigObject.cpp