dunedaq::appmodel::ConfigurationHelper Class Reference

#include <ConfigurationHelper.hpp>

Collaboration diagram for dunedaq::appmodel::ConfigurationHelper:

Public Member Functions
	ConfigurationHelper (const confmodel::Session *ses)
std::vector< const confmodel::Service * >	get_services (std::string app_class, std::string data_type)
	Get the exposed Services of all network connections with given data_type from all smart daq applications of given class.
std::vector< std::pair< std::string, const appmodel::NetworkConnectionDescriptor * > >	get_netdescriptors (const std::string &data_type, const std::string &app_class="")
	Get all NetworkConnectionDescriptors with given data_type from all applications of given type.
std::map< std::string, std::vector< uint32_t > >	get_stream_source_ids ()
	Get the source ids of all DetectorStreams in the Session.
std::map< std::string, std::vector< const SourceIDConf * > >	get_tp_source_ids ()
	Get the source ids of all the TP streams in all ReadoutApplications and TriggerApplications.
std::vector< std::string >	get_app_uids (std::string app_class="")
	Get list of uids of applications that match given type.
std::map< std::string, const SourceIDConf * >	get_app_source_ids (std::string app_class="")
	Get list of source ids for applications that match given type.
std::map< std::string, std::map< std::string, const SourceIDConf * > >	get_all_app_source_ids (std::string app_class="")
	Get list of all source ids for applications that match given type. Follows any single value SourceIDConf relationship.
bool	is_included (const conffwk::DalObject *item)
	Check the include/exclude state of the given item.
bool	is_excluded (const conffwk::DalObject *item)
	Check the include/exclude state of the given item.

Private Attributes
const confmodel::Session *	m_session

Detailed Description

Helper class to extract information from Session object without exposing the Session to user code

Provides methods that loop over all applications in the session to get source IDs etc. avoiding the need for individual application's code to access configuration objects of other applications.

Definition at line 38 of file ConfigurationHelper.hpp.

Constructor & Destructor Documentation

ConfigurationHelper()

dunedaq::appmodel::ConfigurationHelper::ConfigurationHelper ( const confmodel::Session * ses )

inlineexplicit

Definition at line 41 of file ConfigurationHelper.hpp.

    : m_session(ses)
  {
  }

Member Function Documentation

get_all_app_source_ids()

std::map< std::string, std::map< std::string, const SourceIDConf * > > ConfigurationHelper::get_all_app_source_ids

(

std::string

app_class = ""

)

Get list of all source ids for applications that match given type. Follows any single value SourceIDConf relationship.

Examine all relationships of applications checking for type SourceIDConf generating a map of relationship name to SourceIDConf object pointers

NB: Does not look at multi-value SourceIDConf relationships

Parameters

app_class

Class name to select applications by. Empty string implies no selection by class

Returns

A map of application uids to maps relationship to contained source ids

Definition at line 166 of file ConfigurationHelper.cpp.

{
  std::map<std::string, std::map<std::string, const SourceIDConf*>> result;
  for (auto app : m_session->included_applications()) {
    if (app_class.empty() || app->castable(app_class)) {
      auto class_info = app->configuration().get_class_info(app->class_name());
      auto obj = app->config_object();
      for (auto rel : class_info.p_relationships) {
        if (rel.p_type == "SourceIDConf") {
          if (rel.p_cardinality == dunedaq::conffwk::cardinality_t::zero_or_one ||
              rel.p_cardinality == dunedaq::conffwk::cardinality_t::only_one) {
            dunedaq::conffwk::ConfigObject rel_obj;
            obj.get(rel.p_name, rel_obj);
            if (!rel_obj.is_null()) {
              if (!result.contains(app->UID())) {
                result.insert({ app->UID(), {} });
              }
              const auto srcid = app->configuration().get<SourceIDConf>(rel_obj);
              result.at(app->UID()).insert({ rel.p_name, srcid });
            }
          } // cardinality
        } // SourceIDConf
      } // relationships
    } // class
  } // apps
 
  return result;
}

get_app_source_ids()

std::map< std::string, const SourceIDConf * > ConfigurationHelper::get_app_source_ids

(

std::string

app_class = ""

)

Get list of source ids for applications that match given type.

Gather the content of the SmartDaqApplication::source_id relationship for all enabled SmartDaqApplications (or those that match the given class)

Parameters

app_class

Class name to select applications by. Empty string implies no selection by class

Returns

A map of application uids to application source ids

Definition at line 151 of file ConfigurationHelper.cpp.

{
  std::map<std::string, const SourceIDConf*> result;
  for (auto app : m_session->included_applications()) {
    if (app_class.empty() || app->castable(app_class)) {
      auto smart_app = app->cast<SmartDaqApplication>();
      if (smart_app != nullptr && smart_app->get_source_id() != nullptr) {
        result.insert({ app->UID(), smart_app->get_source_id() });
      }
    }
  }
  return result;
}

get_app_uids()

std::vector< std::string > ConfigurationHelper::get_app_uids

(

std::string

app_class = ""

)

Get list of uids of applications that match given type.

Parameters

app_class

Class name to select applications by. Empty string implies no selection by class

Returns

A vector of uids of matching applications

Definition at line 139 of file ConfigurationHelper.cpp.

{
  std::vector<std::string> result;
  for (auto app : m_session->included_applications()) {
    if (app_class.empty() || app->castable(app_class)) {
      result.push_back(app->UID());
    }
  }
  return result;
}

get_netdescriptors()

std::vector< std::pair< std::string, const appmodel::NetworkConnectionDescriptor * > > ConfigurationHelper::get_netdescriptors	(	const std::string &	data_type,
		const std::string &	app_class = "" )

Get all NetworkConnectionDescriptors with given data_type from all applications of given type.

Parameters

data_type	Data type to match in network descriptor
app_class	Optional dal class name to match

Returns

a vector of application uid / network descriptor pairs

Definition at line 35 of file ConfigurationHelper.cpp.

{
  std::vector<std::pair<std::string, const appmodel::NetworkConnectionDescriptor*>> result;
  for (auto app : m_session->included_applications()) {
    if (app_class.empty() || app->castable(app_class)) {
      auto smart_app = app->cast<appmodel::SmartDaqApplication>();
      if (smart_app == nullptr) {
        // Only SmartDaqApplications have network rules
        continue;
      }
      for (auto rule : smart_app->get_network_rules()) {
        auto desc = rule->get_descriptor();
        if (desc->get_data_type() == data_type) {
          result.emplace_back(std::pair{ app->UID(), desc });
        }
      }
    }
  }
  return result;
}

get_services()

std::vector< const confmodel::Service * > ConfigurationHelper::get_services	(	std::string	app_class,
		std::string	data_type )

Get the exposed Services of all network connections with given data_type from all smart daq applications of given class.

Parameters

app_class	Dal class of applications to match
data_type	Data type of network descriptor to match

Returns

A vector of pointers to matching Services

Definition at line 57 of file ConfigurationHelper.cpp.

{
  std::vector<const confmodel::Service*> result;
  for (auto app : m_session->included_applications()) {
    if (app->castable(app_class)) {
      auto smart_app = app->cast<appmodel::SmartDaqApplication>();
      if (smart_app == nullptr) {
        throw(NotSmart(ERS_HERE, app->full_name()));
      }
      for (auto rule : smart_app->get_network_rules()) {
        if (rule->get_descriptor()->get_data_type() == data_type) {
          result.push_back(rule->get_descriptor()->get_associated_service());
        }
      }
    }
  }
  return result;
}

get_stream_source_ids()

std::map< std::string, std::vector< uint32_t > > ConfigurationHelper::get_stream_source_ids

(

)

Get the source ids of all DetectorStreams in the Session.

Returns

A map of application uids to vectors of streams that they contain

Definition at line 77 of file ConfigurationHelper.cpp.

{
  std::map<std::string, std::vector<uint32_t>> result;
  for (auto app : m_session->included_applications()) {
    auto ro_app = app->cast<appmodel::ReadoutApplication>();
    if (ro_app != nullptr) {
      std::vector<uint32_t> streams;
      for (auto res : ro_app->contained_excludable_entities()) {
        if (!res->is_excluded(*m_session)) {
          auto d2d = res->cast<confmodel::DetectorToDaqConnection>();
          if (d2d == nullptr) {
            throw(BadD2d(ERS_HERE, app->full_name(), res->full_name()));
          }
          for (auto stream : d2d->streams()) {
            if (!stream->is_excluded(*m_session)) {
              streams.push_back(stream->get_source_id());
            }
          }
        }
      }
      result.insert(std::pair{ app->UID(), streams });
    } else {
      auto fake_app = app->cast<appmodel::FakeDataApplication>();
      if (fake_app != nullptr) {
        std::vector<uint32_t> streams;
        for (auto res : fake_app->contained_excludable_entities()) {
          if (!res->is_excluded(*m_session)) {
            auto fdpc = res->cast<appmodel::FakeDataProdConf>();
            if (fdpc != nullptr && !fdpc->is_excluded(*m_session)) {
              streams.push_back(fdpc->get_source_id());
            }
          }
        }
        result.insert(std::pair(app->UID(), streams));
      }
    }
  }
  return result;
}

get_tp_source_ids()

std::map< std::string, std::vector< const SourceIDConf * > > ConfigurationHelper::get_tp_source_ids

(

)

Get the source ids of all the TP streams in all ReadoutApplications and TriggerApplications.

Returns

A map of application uids to vectors of contained TP source ids

Definition at line 118 of file ConfigurationHelper.cpp.

{
  std::map<std::string, std::vector<const SourceIDConf*>> result;
  for (auto app : m_session->included_applications()) {
    auto ro_app = app->cast<appmodel::ReadoutApplication>();
    if (ro_app != nullptr) {
      if (ro_app->get_tp_generation_enabled()) {
        result.insert(std::pair(app->UID(), ro_app->get_tp_source_ids()));
      } else {
        result.insert({ app->UID(), std::vector<const SourceIDConf*>() });
      }
    }
    auto replay_app = app->cast<appmodel::TPReplayApplication>();
    if (replay_app != nullptr) {
      result.insert(std::pair(app->UID(), replay_app->get_tp_source_ids()));
    }
  }
  return result;
}

is_excluded()

bool ConfigurationHelper::is_excluded

(

const conffwk::DalObject *

item

)

Check the include/exclude state of the given item.

Parameters

item	The item to be checked.

Returns

True if the object is excluded

Definition at line 196 of file ConfigurationHelper.cpp.

{
  auto res = item->cast<confmodel::ExcludableEntity>();
  if (res == nullptr) {
    return false;
  }
  return res->is_excluded(*m_session);
}

is_included()

bool dunedaq::appmodel::ConfigurationHelper::is_included ( const conffwk::DalObject * item )

inline

Check the include/exclude state of the given item.

Parameters

item	The item to be checked.

Returns

True if the object is included

Definition at line 122 of file ConfigurationHelper.hpp.

{ return !is_excluded(item); }

Member Data Documentation

m_session

const confmodel::Session* dunedaq::appmodel::ConfigurationHelper::m_session

private

Definition at line 132 of file ConfigurationHelper.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/appmodel/include/appmodel/ConfigurationHelper.hpp
• /github/workspace/dunedaq/sourcecode/appmodel/src/ConfigurationHelper.cpp