dunedaq::appmodel::HDF5FileLayoutParams Class Reference

#include <HDF5FileLayoutParams.hpp>

Inheritance diagram for dunedaq::appmodel::HDF5FileLayoutParams:

Collaboration diagram for dunedaq::appmodel::HDF5FileLayoutParams:

Public Member Functions
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the HDF5FileLayoutParams object.
virtual std::vector< const dunedaq::conffwk::DalObject * >	get (const std::string &name, bool upcast_unregistered=true) const
	Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
const std::string &	get_record_name_prefix () const
	Get "record_name_prefix" attribute value.
void	set_record_name_prefix (const std::string &value)
	Set "record_name_prefix" attribute value.
int32_t	get_digits_for_record_number () const
	Get "digits_for_record_number" attribute value.
void	set_digits_for_record_number (int32_t value)
	Set "digits_for_record_number" attribute value.
int32_t	get_digits_for_sequence_number () const
	Get "digits_for_sequence_number" attribute value.
void	set_digits_for_sequence_number (int32_t value)
	Set "digits_for_sequence_number" attribute value.
const std::string &	get_record_header_dataset_name () const
	Get "record_header_dataset_name" attribute value.
void	set_record_header_dataset_name (const std::string &value)
	Set "record_header_dataset_name" attribute value.
const std::string &	get_raw_data_group_name () const
	Get "raw_data_group_name" attribute value.
void	set_raw_data_group_name (const std::string &value)
	Set "raw_data_group_name" attribute value.
const std::string &	get_view_group_name () const
	Get "view_group_name" attribute value.
void	set_view_group_name (const std::string &value)
	Set "view_group_name" attribute value.
const std::vector< const dunedaq::appmodel::HDF5PathParams * > &	get_path_params_list () const
	Get "path_params_list" relationship value.
void	set_path_params_list (const std::vector< const dunedaq::appmodel::HDF5PathParams * > &value)
	Set "path_params_list" relationship value.
virtual void	print (unsigned int offset, bool print_header, std::ostream &s) const
	Print details of the HDF5FileLayoutParams object.
virtual std::vector< const dunedaq::conffwk::DalObject * >	get (const std::string &name, bool upcast_unregistered=true) const
	Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.
const std::string &	get_record_name_prefix () const
	Get "record_name_prefix" attribute value.
void	set_record_name_prefix (const std::string &value)
	Set "record_name_prefix" attribute value.
int32_t	get_digits_for_record_number () const
	Get "digits_for_record_number" attribute value.
void	set_digits_for_record_number (int32_t value)
	Set "digits_for_record_number" attribute value.
int32_t	get_digits_for_sequence_number () const
	Get "digits_for_sequence_number" attribute value.
void	set_digits_for_sequence_number (int32_t value)
	Set "digits_for_sequence_number" attribute value.
const std::string &	get_record_header_dataset_name () const
	Get "record_header_dataset_name" attribute value.
void	set_record_header_dataset_name (const std::string &value)
	Set "record_header_dataset_name" attribute value.
const std::string &	get_raw_data_group_name () const
	Get "raw_data_group_name" attribute value.
void	set_raw_data_group_name (const std::string &value)
	Set "raw_data_group_name" attribute value.
const std::string &	get_view_group_name () const
	Get "view_group_name" attribute value.
void	set_view_group_name (const std::string &value)
	Set "view_group_name" attribute value.
const std::vector< const dunedaq::appmodel::HDF5PathParams * > &	get_path_params_list () const
	Get "path_params_list" relationship value.
void	set_path_params_list (const std::vector< const dunedaq::appmodel::HDF5PathParams * > &value)
	Set "path_params_list" relationship value.
Public Member Functions inherited from dunedaq::conffwk::DalObject
const std::string &	UID () const noexcept
const std::string &	class_name () const noexcept
bool	castable (const std::string &target) const noexcept
bool	castable (const std::string *target) const noexcept
template<class TARGET >
const TARGET *	cast () const noexcept
	Casts object to different class.
std::string	full_name () const noexcept
const ConfigObject &	config_object () const
DalRegistry &	registry () const noexcept
Configuration &	configuration () const noexcept
void	unread ()
void	set (const ConfigObject &o) noexcept
void	move (const std::string &at)
void	rename (const std::string &new_id)
void	p_hdr (std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
	print object headers
std::ostream &	print_object (std::ostream &s) const
	print object details
void	throw_init_ex (dunedaq::conffwk::Exception &ex)
	throw object initialisation exception (i.e.

Static Public Member Functions
static const std::string &	__get_record_name_prefix_str () noexcept
static const std::string &	__get_digits_for_record_number_str () noexcept
static const std::string &	__get_digits_for_sequence_number_str () noexcept
static const std::string &	__get_record_header_dataset_name_str () noexcept
static const std::string &	__get_raw_data_group_name_str () noexcept
static const std::string &	__get_view_group_name_str () noexcept
static const std::string &	__get_path_params_list_str () noexcept
static const std::string &	__get_record_name_prefix_str () noexcept
static const std::string &	__get_digits_for_record_number_str () noexcept
static const std::string &	__get_digits_for_sequence_number_str () noexcept
static const std::string &	__get_record_header_dataset_name_str () noexcept
static const std::string &	__get_raw_data_group_name_str () noexcept
static const std::string &	__get_view_group_name_str () noexcept
static const std::string &	__get_path_params_list_str () noexcept
Static Public Member Functions inherited from dunedaq::conffwk::DalObject
static void	p_null (std::ostream &s)
	print "(null)"
static void	p_rm (std::ostream &s)
	print "(deleted object)"
static void	p_error (std::ostream &s, dunedaq::conffwk::Exception &ex)
	print error text
static void	throw_get_ex (const std::string &what, const std::string &class_name, const DalObject *obj)
	throw exception in generated get method (i.e.
static bool	is_null (const DalObject *ref) noexcept
	check a pointer on DAL object is null

Static Public Attributes
static const std::string &	s_class_name
static const std::string	s_record_name_prefix = "record_name_prefix"
static const std::string	s_digits_for_record_number = "digits_for_record_number"
static const std::string	s_digits_for_sequence_number = "digits_for_sequence_number"
static const std::string	s_record_header_dataset_name = "record_header_dataset_name"
static const std::string	s_raw_data_group_name = "raw_data_group_name"
static const std::string	s_view_group_name = "view_group_name"
static const std::string	s_path_params_list = "path_params_list"

Protected Member Functions
	HDF5FileLayoutParams (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~HDF5FileLayoutParams () noexcept
virtual void	init (bool init_children)
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
	HDF5FileLayoutParams (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
virtual	~HDF5FileLayoutParams () noexcept
virtual void	init (bool init_children)
bool	get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
Protected Member Functions inherited from dunedaq::conffwk::DalObject
	DalObject (DalRegistry &db, const ConfigObject &o) noexcept
virtual	~DalObject ()
void	clear () noexcept
void	check () const
bool	is_deleted () const
void	increment_created () noexcept
void	increment_read () noexcept
void	check_init () const
	Check and initialize object if necessary.
template<typename T >
void	_set_object (const std::string &name, const T *value)
	Helper method for generated set single-value relationship methods.
template<typename T >
void	_set_objects (const std::string &name, const std::vector< const T * > &value)
	Helper method for generated set multi-value relationship methods.
bool	get_rel_objects (const std::string &name, bool upcast_unregistered, std::vector< const DalObject * > &objs) const
	Read relationship values as DAL objects using DAL factory.
bool	get_algo_objects (const std::string &name, std::vector< const DalObject * > &objs) const
	Run algorithm and return result as DAL objects using DAL factory.

Private Attributes
std::string	m_record_name_prefix
int32_t	m_digits_for_record_number
int32_t	m_digits_for_sequence_number
std::string	m_record_header_dataset_name
std::string	m_raw_data_group_name
std::string	m_view_group_name
std::vector< const dunedaq::appmodel::HDF5PathParams * >	m_path_params_list

Friends
class	conffwk::Configuration
class	conffwk::DalObject
class	conffwk::DalFactory
class	conffwk::DalRegistry

Additional Inherited Members
Protected Attributes inherited from dunedaq::conffwk::DalObject
std::mutex	m_mutex
	Used to protect changes of DAL object.
bool	p_was_read
	is true, if the object was read
DalRegistry &	p_registry
	Configuration object.
ConfigObject	p_obj
	Config object used by given template object.
std::string	p_UID
	Is used for template objects (see dqm_conffwk)

Detailed Description

Definition at line 29 of file HDF5FileLayoutParams.hpp.

Constructor & Destructor Documentation

HDF5FileLayoutParams() [1/2]

dunedaq::appmodel::HDF5FileLayoutParams::HDF5FileLayoutParams ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

Definition at line 31 of file HDF5FileLayoutParams.cpp.

                                                                                                            :
      dunedaq::conffwk::DalObject(db, o)
    {
      ;
    }

~HDF5FileLayoutParams() [1/2]

dunedaq::appmodel::HDF5FileLayoutParams::~HDF5FileLayoutParams ( )

protectedvirtualnoexcept

Definition at line 89 of file HDF5FileLayoutParams.cpp.

    {
    }

HDF5FileLayoutParams() [2/2]

dunedaq::appmodel::HDF5FileLayoutParams::HDF5FileLayoutParams ( conffwk::DalRegistry & db, const conffwk::ConfigObject & obj )

protectednoexcept

~HDF5FileLayoutParams() [2/2]

virtual dunedaq::appmodel::HDF5FileLayoutParams::~HDF5FileLayoutParams ( )

protectedvirtualnoexcept

Member Function Documentation

__get_digits_for_record_number_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_digits_for_record_number_str ( )

inlinestaticnoexcept

Definition at line 101 of file HDF5FileLayoutParams.hpp.

{ return s_digits_for_record_number; }

__get_digits_for_record_number_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_digits_for_record_number_str ( )

inlinestaticnoexcept

Definition at line 101 of file HDF5FileLayoutParams.hpp.

{ return s_digits_for_record_number; }

__get_digits_for_sequence_number_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_digits_for_sequence_number_str ( )

inlinestaticnoexcept

Definition at line 102 of file HDF5FileLayoutParams.hpp.

{ return s_digits_for_sequence_number; }

__get_digits_for_sequence_number_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_digits_for_sequence_number_str ( )

inlinestaticnoexcept

Definition at line 102 of file HDF5FileLayoutParams.hpp.

{ return s_digits_for_sequence_number; }

__get_path_params_list_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_path_params_list_str ( )

inlinestaticnoexcept

Definition at line 298 of file HDF5FileLayoutParams.hpp.

{ return s_path_params_list; }

__get_path_params_list_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_path_params_list_str ( )

inlinestaticnoexcept

Definition at line 298 of file HDF5FileLayoutParams.hpp.

{ return s_path_params_list; }

__get_raw_data_group_name_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_raw_data_group_name_str ( )

inlinestaticnoexcept

Definition at line 104 of file HDF5FileLayoutParams.hpp.

{ return s_raw_data_group_name; }

__get_raw_data_group_name_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_raw_data_group_name_str ( )

inlinestaticnoexcept

Definition at line 104 of file HDF5FileLayoutParams.hpp.

{ return s_raw_data_group_name; }

__get_record_header_dataset_name_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_record_header_dataset_name_str ( )

inlinestaticnoexcept

Definition at line 103 of file HDF5FileLayoutParams.hpp.

{ return s_record_header_dataset_name; }

__get_record_header_dataset_name_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_record_header_dataset_name_str ( )

inlinestaticnoexcept

Definition at line 103 of file HDF5FileLayoutParams.hpp.

{ return s_record_header_dataset_name; }

__get_record_name_prefix_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_record_name_prefix_str ( )

inlinestaticnoexcept

Definition at line 100 of file HDF5FileLayoutParams.hpp.

{ return s_record_name_prefix; }

__get_record_name_prefix_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_record_name_prefix_str ( )

inlinestaticnoexcept

Definition at line 100 of file HDF5FileLayoutParams.hpp.

{ return s_record_name_prefix; }

__get_view_group_name_str() [1/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_view_group_name_str ( )

inlinestaticnoexcept

Definition at line 105 of file HDF5FileLayoutParams.hpp.

{ return s_view_group_name; }

__get_view_group_name_str() [2/2]

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::__get_view_group_name_str ( )

inlinestaticnoexcept

Definition at line 105 of file HDF5FileLayoutParams.hpp.

{ return s_view_group_name; }

get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::HDF5FileLayoutParams::get ( const std::string & name, bool upcast_unregistered = true ) const

virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters

name	name of the relationship or algorithm

Returns

value of relationship or result of algorithm

Exceptions

std::exception

if there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

Definition at line 93 of file HDF5FileLayoutParams.cpp.

    {
      std::vector<const dunedaq::conffwk::DalObject *> vec;
 
      if (!get(name, vec, upcast_unregistered, true))
        throw_get_ex(name, s_class_name, this);
 
      return vec;
    }

get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::HDF5FileLayoutParams::get ( const std::string & name, bool upcast_unregistered = true ) const

virtual

Get values of relationships and results of some algorithms as a vector of dunedaq::conffwk::DalObject pointers.

Parameters are:

Parameters

name	name of the relationship or algorithm

Returns

value of relationship or result of algorithm

Exceptions

std::exception

if there is no relationship or algorithm with such name in this and base classes

Implements dunedaq::conffwk::DalObject.

get() [3/4]

bool dunedaq::appmodel::HDF5FileLayoutParams::get ( const std::string & name, std::vector< const dunedaq::conffwk::DalObject * > & vec, bool upcast_unregistered, bool first_call ) const

protected

Definition at line 103 of file HDF5FileLayoutParams.cpp.

    {
      if (first_call)
        {
          std::lock_guard scoped_lock(m_mutex);
 
          check();
          check_init();
 
          if (get_rel_objects(name, upcast_unregistered, vec))
            return true;
        }
 
      if (first_call)
        return get_algo_objects(name, vec);
 
      return false;
    }

get() [4/4]

bool dunedaq::appmodel::HDF5FileLayoutParams::get ( const std::string & name, std::vector< const dunedaq::conffwk::DalObject * > & vec, bool upcast_unregistered, bool first_call ) const

protected

get_digits_for_record_number() [1/2]

int32_t dunedaq::appmodel::HDF5FileLayoutParams::get_digits_for_record_number ( ) const

inline

Get "digits_for_record_number" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 146 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_digits_for_record_number;
          }

get_digits_for_record_number() [2/2]

int32_t dunedaq::appmodel::HDF5FileLayoutParams::get_digits_for_record_number ( ) const

inline

Get "digits_for_record_number" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 146 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_digits_for_record_number;
          }

get_digits_for_sequence_number() [1/2]

int32_t dunedaq::appmodel::HDF5FileLayoutParams::get_digits_for_sequence_number ( ) const

inline

Get "digits_for_sequence_number" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 177 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_digits_for_sequence_number;
          }

get_digits_for_sequence_number() [2/2]

int32_t dunedaq::appmodel::HDF5FileLayoutParams::get_digits_for_sequence_number ( ) const

inline

Get "digits_for_sequence_number" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 177 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_digits_for_sequence_number;
          }

get_path_params_list() [1/2]

const std::vector< const dunedaq::appmodel::HDF5PathParams * > & dunedaq::appmodel::HDF5FileLayoutParams::get_path_params_list ( ) const

inline

Get "path_params_list" relationship value.

Returns

the relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 308 of file HDF5FileLayoutParams.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_path_params_list.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_path_params_list << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_path_params_list;
        }

get_path_params_list() [2/2]

const std::vector< const dunedaq::appmodel::HDF5PathParams * > & dunedaq::appmodel::HDF5FileLayoutParams::get_path_params_list ( ) const

inline

Get "path_params_list" relationship value.

Returns

the relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 308 of file HDF5FileLayoutParams.hpp.

        {
          std::lock_guard scoped_lock(m_mutex);
          check();
          check_init();
          if (m_path_params_list.empty())
            {
              std::ostringstream text;
              text << "relationship \"" << s_path_params_list << "\" of object " << this << " is empty";
              throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
            }
          return m_path_params_list;
        }

get_raw_data_group_name() [1/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_raw_data_group_name ( ) const

inline

Get "raw_data_group_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 239 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_raw_data_group_name;
          }

get_raw_data_group_name() [2/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_raw_data_group_name ( ) const

inline

Get "raw_data_group_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 239 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_raw_data_group_name;
          }

get_record_header_dataset_name() [1/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_record_header_dataset_name ( ) const

inline

Get "record_header_dataset_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 208 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_record_header_dataset_name;
          }

get_record_header_dataset_name() [2/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_record_header_dataset_name ( ) const

inline

Get "record_header_dataset_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 208 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_record_header_dataset_name;
          }

get_record_name_prefix() [1/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_record_name_prefix ( ) const

inline

Get "record_name_prefix" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 115 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_record_name_prefix;
          }

get_record_name_prefix() [2/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_record_name_prefix ( ) const

inline

Get "record_name_prefix" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 115 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_record_name_prefix;
          }

get_view_group_name() [1/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_view_group_name ( ) const

inline

Get "view_group_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 270 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_view_group_name;
          }

get_view_group_name() [2/2]

const std::string & dunedaq::appmodel::HDF5FileLayoutParams::get_view_group_name ( ) const

inline

Get "view_group_name" attribute value.

Returns

the attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 270 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            check_init();
            return m_view_group_name;
          }

init() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Definition at line 69 of file HDF5FileLayoutParams.cpp.

    {
      p_was_read = true;
      increment_read();
      TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
 
      try {
        p_obj.get(s_record_name_prefix, m_record_name_prefix);
        p_obj.get(s_digits_for_record_number, m_digits_for_record_number);
        p_obj.get(s_digits_for_sequence_number, m_digits_for_sequence_number);
        p_obj.get(s_record_header_dataset_name, m_record_header_dataset_name);
        p_obj.get(s_raw_data_group_name, m_raw_data_group_name);
        p_obj.get(s_view_group_name, m_view_group_name);
        p_registry._ref<dunedaq::appmodel::HDF5PathParams>(p_obj, s_path_params_list, m_path_params_list, init_children);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        throw_init_ex(ex);
      }
    }

init() [2/2]

virtual void dunedaq::appmodel::HDF5FileLayoutParams::init ( bool init_children )

protectedvirtual

Initialize object (method generated by genconffwk)

Parameters

init_children

if true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

print() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the HDF5FileLayoutParams object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Implements dunedaq::conffwk::DalObject.

Definition at line 38 of file HDF5FileLayoutParams.cpp.

    {
      check_init();
 
      try {
        const std::string str(indent+2, ' ');
 
        if (print_header)
          p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
 
 
          // print direct attributes
 
        dunedaq::conffwk::p_sv_attr(s, str, s_record_name_prefix, m_record_name_prefix);
        dunedaq::conffwk::p_sv_attr(s, str, s_digits_for_record_number, m_digits_for_record_number);
        dunedaq::conffwk::p_sv_attr(s, str, s_digits_for_sequence_number, m_digits_for_sequence_number);
        dunedaq::conffwk::p_sv_attr(s, str, s_record_header_dataset_name, m_record_header_dataset_name);
        dunedaq::conffwk::p_sv_attr(s, str, s_raw_data_group_name, m_raw_data_group_name);
        dunedaq::conffwk::p_sv_attr(s, str, s_view_group_name, m_view_group_name);
 
 
          // print direct relationships
 
        dunedaq::conffwk::p_mv_rel(s, str, s_path_params_list, m_path_params_list);
      }
      catch (dunedaq::conffwk::Exception & ex) {
        dunedaq::conffwk::DalObject::p_error(s, ex);
      }
    }

print() [2/2]

virtual void dunedaq::appmodel::HDF5FileLayoutParams::print ( unsigned int offset, bool print_header, std::ostream & s ) const

virtual

Print details of the HDF5FileLayoutParams object.

Parameters are:

Parameters

offset	number of spaces to shift object right (useful to print nested objects)
print_header	if false, do not print object header (to print attributes of base classes)
s	output stream

Implements dunedaq::conffwk::DalObject.

set_digits_for_record_number() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_digits_for_record_number ( int32_t value )

inline

Set "digits_for_record_number" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 161 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_digits_for_record_number, value);
          }

set_digits_for_record_number() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_digits_for_record_number ( int32_t value )

inline

Set "digits_for_record_number" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 161 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_digits_for_record_number, value);
          }

set_digits_for_sequence_number() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_digits_for_sequence_number ( int32_t value )

inline

Set "digits_for_sequence_number" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 192 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_digits_for_sequence_number, value);
          }

set_digits_for_sequence_number() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_digits_for_sequence_number ( int32_t value )

inline

Set "digits_for_sequence_number" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 192 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_val(s_digits_for_sequence_number, value);
          }

set_path_params_list() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_path_params_list

(

const std::vector< const dunedaq::appmodel::HDF5PathParams * > &

value

)

Set "path_params_list" relationship value.

Parameters

value

new relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 122 of file HDF5FileLayoutParams.cpp.

    {
      _set_objects(s_path_params_list, value);
    }

set_path_params_list() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_path_params_list

(

const std::vector< const dunedaq::appmodel::HDF5PathParams * > &

value

)

Set "path_params_list" relationship value.

Parameters

value

new relationship value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

set_raw_data_group_name() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_raw_data_group_name ( const std::string & value )

inline

Set "raw_data_group_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 254 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_raw_data_group_name, value);
          }

set_raw_data_group_name() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_raw_data_group_name ( const std::string & value )

inline

Set "raw_data_group_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 254 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_raw_data_group_name, value);
          }

set_record_header_dataset_name() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_record_header_dataset_name ( const std::string & value )

inline

Set "record_header_dataset_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 223 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_record_header_dataset_name, value);
          }

set_record_header_dataset_name() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_record_header_dataset_name ( const std::string & value )

inline

Set "record_header_dataset_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 223 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_record_header_dataset_name, value);
          }

set_record_name_prefix() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_record_name_prefix ( const std::string & value )

inline

Set "record_name_prefix" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 130 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_record_name_prefix, value);
          }

set_record_name_prefix() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_record_name_prefix ( const std::string & value )

inline

Set "record_name_prefix" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 130 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_record_name_prefix, value);
          }

set_view_group_name() [1/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_view_group_name ( const std::string & value )

inline

Set "view_group_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 285 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_view_group_name, value);
          }

set_view_group_name() [2/2]

void dunedaq::appmodel::HDF5FileLayoutParams::set_view_group_name ( const std::string & value )

inline

Set "view_group_name" attribute value.

Parameters

value

new attribute value

Exceptions

dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 285 of file HDF5FileLayoutParams.hpp.

          {
            std::lock_guard scoped_lock(m_mutex);
            check();
            clear();
            p_obj.set_by_ref(s_view_group_name, value);
          }

Friends And Related Symbol Documentation

conffwk::Configuration

conffwk::Configuration

friend

Definition at line 31 of file HDF5FileLayoutParams.hpp.

conffwk::DalFactory

conffwk::DalFactory

friend

Definition at line 33 of file HDF5FileLayoutParams.hpp.

conffwk::DalObject

conffwk::DalObject

friend

Definition at line 32 of file HDF5FileLayoutParams.hpp.

conffwk::DalRegistry

conffwk::DalRegistry

friend

Definition at line 34 of file HDF5FileLayoutParams.hpp.

Member Data Documentation

m_digits_for_record_number

int32_t dunedaq::appmodel::HDF5FileLayoutParams::m_digits_for_record_number

private

Definition at line 81 of file HDF5FileLayoutParams.hpp.

m_digits_for_sequence_number

int32_t dunedaq::appmodel::HDF5FileLayoutParams::m_digits_for_sequence_number

private

Definition at line 82 of file HDF5FileLayoutParams.hpp.

m_path_params_list

std::vector< const dunedaq::appmodel::HDF5PathParams * > dunedaq::appmodel::HDF5FileLayoutParams::m_path_params_list

private

Definition at line 86 of file HDF5FileLayoutParams.hpp.

m_raw_data_group_name

std::string dunedaq::appmodel::HDF5FileLayoutParams::m_raw_data_group_name

private

Definition at line 84 of file HDF5FileLayoutParams.hpp.

m_record_header_dataset_name

std::string dunedaq::appmodel::HDF5FileLayoutParams::m_record_header_dataset_name

private

Definition at line 83 of file HDF5FileLayoutParams.hpp.

m_record_name_prefix

std::string dunedaq::appmodel::HDF5FileLayoutParams::m_record_name_prefix

private

Definition at line 80 of file HDF5FileLayoutParams.hpp.

m_view_group_name

std::string dunedaq::appmodel::HDF5FileLayoutParams::m_view_group_name

private

Definition at line 85 of file HDF5FileLayoutParams.hpp.

s_class_name

static const std::string & dunedaq::appmodel::HDF5FileLayoutParams::s_class_name

static

The name of the configuration class.

Definition at line 46 of file HDF5FileLayoutParams.hpp.

s_digits_for_record_number

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_digits_for_record_number = "digits_for_record_number"

inlinestatic

Definition at line 94 of file HDF5FileLayoutParams.hpp.

s_digits_for_sequence_number

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_digits_for_sequence_number = "digits_for_sequence_number"

inlinestatic

Definition at line 95 of file HDF5FileLayoutParams.hpp.

s_path_params_list

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_path_params_list = "path_params_list"

inlinestatic

Definition at line 296 of file HDF5FileLayoutParams.hpp.

s_raw_data_group_name

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_raw_data_group_name = "raw_data_group_name"

inlinestatic

Definition at line 97 of file HDF5FileLayoutParams.hpp.

s_record_header_dataset_name

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_record_header_dataset_name = "record_header_dataset_name"

inlinestatic

Definition at line 96 of file HDF5FileLayoutParams.hpp.

s_record_name_prefix

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_record_name_prefix = "record_name_prefix"

inlinestatic

Definition at line 93 of file HDF5FileLayoutParams.hpp.

s_view_group_name

static const std::string dunedaq::appmodel::HDF5FileLayoutParams::s_view_group_name = "view_group_name"

inlinestatic

Definition at line 98 of file HDF5FileLayoutParams.hpp.

---

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

• /github/workspace/dunedaq/build/appmodel/codegen/include/appmodel/HDF5FileLayoutParams.hpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/HDF5FileLayoutParams.hpp
• /github/workspace/dunedaq/build/appmodel/codegen/src/HDF5FileLayoutParams.cpp