DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
dunedaq::appmodel::DFApplication Class Reference

#include <DFApplication.hpp>

Inheritance diagram for dunedaq::appmodel::DFApplication:
[legend]
Collaboration diagram for dunedaq::appmodel::DFApplication:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DFApplication 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 dunedaq::appmodel::TRBConfget_trb () const
 Get "trb" relationship value. Configuration of the TRB to be generated my get_modules()
 
void set_trb (const dunedaq::appmodel::TRBConf *value)
 Set "trb" relationship value. Configuration of the TRB to be generated my get_modules()
 
const std::vector< const dunedaq::appmodel::DataWriterConf * > & get_data_writers () const
 Get "data_writers" relationship value.
 
void set_data_writers (const std::vector< const dunedaq::appmodel::DataWriterConf * > &value)
 Set "data_writers" relationship value.
 
const dunedaq::appmodel::DFHWConfget_uses () const
 Get "uses" relationship value.
 
void set_uses (const dunedaq::appmodel::DFHWConf *value)
 Set "uses" relationship value.
 
std::vector< const dunedaq::confmodel::DaqModule * > generate_modules (const confmodel::Session *) const override
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the DFApplication 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 dunedaq::appmodel::TRBConfget_trb () const
 Get "trb" relationship value. Configuration of the TRB to be generated my get_modules()
 
void set_trb (const dunedaq::appmodel::TRBConf *value)
 Set "trb" relationship value. Configuration of the TRB to be generated my get_modules()
 
const std::vector< const dunedaq::appmodel::DataWriterConf * > & get_data_writers () const
 Get "data_writers" relationship value.
 
void set_data_writers (const std::vector< const dunedaq::appmodel::DataWriterConf * > &value)
 Set "data_writers" relationship value.
 
const dunedaq::appmodel::DFHWConfget_uses () const
 Get "uses" relationship value.
 
void set_uses (const dunedaq::appmodel::DFHWConf *value)
 Set "uses" relationship value.
 
std::vector< const dunedaq::confmodel::DaqModule * > generate_modules (const confmodel::Session *) const override
 
- Public Member Functions inherited from dunedaq::confmodel::Resource
- Public Member Functions inherited from dunedaq::confmodel::ResourceBase
- Public Member Functions inherited from dunedaq::confmodel::Component
void get_parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Component * > > &parents) const
 
bool disabled (const dunedaq::confmodel::Session &session) const
 
void get_parents (const dunedaq::confmodel::Session &session, std::list< std::vector< const dunedaq::confmodel::Component * > > &parents) const
 
bool disabled (const dunedaq::confmodel::Session &session) const
 
- 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 ConfigObjectconfig_object () const
 
DalRegistryregistry () const noexcept
 
Configurationconfiguration () 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.
 
- Public Member Functions inherited from dunedaq::appmodel::SmartDaqApplication
const dunedaq::appmodel::SourceIDConfget_source_id () const
 Get "source_id" relationship value.
 
void set_source_id (const dunedaq::appmodel::SourceIDConf *value)
 Set "source_id" relationship value.
 
const std::vector< const dunedaq::appmodel::QueueConnectionRule * > & get_queue_rules () const
 Get "queue_rules" relationship value.
 
void set_queue_rules (const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &value)
 Set "queue_rules" relationship value.
 
const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > & get_network_rules () const
 Get "network_rules" relationship value.
 
void set_network_rules (const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &value)
 Set "network_rules" relationship value.
 
const std::vector< const dunedaq::confmodel::ActionPlan * > & get_action_plans () const
 Get "action_plans" relationship value.
 
void set_action_plans (const std::vector< const dunedaq::confmodel::ActionPlan * > &value)
 Set "action_plans" relationship value.
 
const std::vector< std::string > construct_commandline_parameters (const conffwk::Configuration &confdb, const dunedaq::confmodel::Session *session) const
 
const dunedaq::appmodel::SourceIDConfget_source_id () const
 Get "source_id" relationship value.
 
void set_source_id (const dunedaq::appmodel::SourceIDConf *value)
 Set "source_id" relationship value.
 
const std::vector< const dunedaq::appmodel::QueueConnectionRule * > & get_queue_rules () const
 Get "queue_rules" relationship value.
 
void set_queue_rules (const std::vector< const dunedaq::appmodel::QueueConnectionRule * > &value)
 Set "queue_rules" relationship value.
 
const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > & get_network_rules () const
 Get "network_rules" relationship value.
 
void set_network_rules (const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > &value)
 Set "network_rules" relationship value.
 
const std::vector< const dunedaq::confmodel::ActionPlan * > & get_action_plans () const
 Get "action_plans" relationship value.
 
void set_action_plans (const std::vector< const dunedaq::confmodel::ActionPlan * > &value)
 Set "action_plans" relationship value.
 
const std::vector< std::string > construct_commandline_parameters (const conffwk::Configuration &confdb, const dunedaq::confmodel::Session *session) const
 
- Public Member Functions inherited from dunedaq::confmodel::Application
const std::string & get_application_name () const
 Get "application_name" attribute value. Name of the application binary to run.
 
void set_application_name (const std::string &value)
 Set "application_name" attribute value. Name of the application binary to run.
 
const std::vector< std::string > & get_commandline_parameters () const
 Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
 
void set_commandline_parameters (const std::vector< std::string > &value)
 Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
 
const std::string & get_log_path () const
 Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
 
void set_log_path (const std::string &value)
 Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
 
const std::vector< const dunedaq::confmodel::VariableBase * > & get_application_environment () const
 Get "application_environment" relationship value. Define process environment for this application.
 
void set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
 Set "application_environment" relationship value. Define process environment for this application.
 
const dunedaq::confmodel::VirtualHostget_runs_on () const
 Get "runs_on" relationship value. VirtualHost to run this application on.
 
void set_runs_on (const dunedaq::confmodel::VirtualHost *value)
 Set "runs_on" relationship value. VirtualHost to run this application on.
 
const std::vector< const dunedaq::confmodel::Service * > & get_exposes_service () const
 Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
 
void set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
 Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
 
const dunedaq::confmodel::OpMonConfget_opmon_conf () const
 Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
 
void set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
 Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
 
const std::vector< std::string > parse_commandline_parameters () const
 
const std::string & get_application_name () const
 Get "application_name" attribute value. Name of the application binary to run.
 
void set_application_name (const std::string &value)
 Set "application_name" attribute value. Name of the application binary to run.
 
const std::vector< std::string > & get_commandline_parameters () const
 Get "commandline_parameters" attribute value. command line parameters to add when starting the application.
 
void set_commandline_parameters (const std::vector< std::string > &value)
 Set "commandline_parameters" attribute value. command line parameters to add when starting the application.
 
const std::string & get_log_path () const
 Get "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
 
void set_log_path (const std::string &value)
 Set "log_path" attribute value. Where the applications, controllers and infrastructure applications stdout/err go. This take precedence over the Session's log_path. If none of them is set, PWD is used.
 
const std::vector< const dunedaq::confmodel::VariableBase * > & get_application_environment () const
 Get "application_environment" relationship value. Define process environment for this application.
 
void set_application_environment (const std::vector< const dunedaq::confmodel::VariableBase * > &value)
 Set "application_environment" relationship value. Define process environment for this application.
 
const dunedaq::confmodel::VirtualHostget_runs_on () const
 Get "runs_on" relationship value. VirtualHost to run this application on.
 
void set_runs_on (const dunedaq::confmodel::VirtualHost *value)
 Set "runs_on" relationship value. VirtualHost to run this application on.
 
const std::vector< const dunedaq::confmodel::Service * > & get_exposes_service () const
 Get "exposes_service" relationship value. Services exposed i.e. provided by this application.
 
void set_exposes_service (const std::vector< const dunedaq::confmodel::Service * > &value)
 Set "exposes_service" relationship value. Services exposed i.e. provided by this application.
 
const dunedaq::confmodel::OpMonConfget_opmon_conf () const
 Get "opmon_conf" relationship value. description of the monitoring behaviour in the application.
 
void set_opmon_conf (const dunedaq::confmodel::OpMonConf *value)
 Set "opmon_conf" relationship value. description of the monitoring behaviour in the application.
 
const std::vector< std::string > parse_commandline_parameters () const
 

Static Public Member Functions

static const std::string & __get_trb_str () noexcept
 
static const std::string & __get_data_writers_str () noexcept
 
static const std::string & __get_uses_str () noexcept
 
static const std::string & __get_trb_str () noexcept
 
static const std::string & __get_data_writers_str () noexcept
 
static const std::string & __get_uses_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 Member Functions inherited from dunedaq::appmodel::SmartDaqApplication
static const std::string & __get_source_id_str () noexcept
 
static const std::string & __get_queue_rules_str () noexcept
 
static const std::string & __get_network_rules_str () noexcept
 
static const std::string & __get_action_plans_str () noexcept
 
static const std::string & __get_source_id_str () noexcept
 
static const std::string & __get_queue_rules_str () noexcept
 
static const std::string & __get_network_rules_str () noexcept
 
static const std::string & __get_action_plans_str () noexcept
 
- Static Public Member Functions inherited from dunedaq::confmodel::Application
static const std::string & __get_application_name_str () noexcept
 
static const std::string & __get_commandline_parameters_str () noexcept
 
static const std::string & __get_log_path_str () noexcept
 
static const std::string & __get_application_environment_str () noexcept
 
static const std::string & __get_runs_on_str () noexcept
 
static const std::string & __get_exposes_service_str () noexcept
 
static const std::string & __get_opmon_conf_str () noexcept
 
static const std::string & __get_application_name_str () noexcept
 
static const std::string & __get_commandline_parameters_str () noexcept
 
static const std::string & __get_log_path_str () noexcept
 
static const std::string & __get_application_environment_str () noexcept
 
static const std::string & __get_runs_on_str () noexcept
 
static const std::string & __get_exposes_service_str () noexcept
 
static const std::string & __get_opmon_conf_str () noexcept
 

Static Public Attributes

static const std::string & s_class_name
 
static const std::string s_trb = "trb"
 
static const std::string s_data_writers = "data_writers"
 
static const std::string s_uses = "uses"
 
- Static Public Attributes inherited from dunedaq::confmodel::Resource
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::ResourceBase
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::confmodel::Component
static const std::string & s_class_name
 
- Static Public Attributes inherited from dunedaq::appmodel::SmartDaqApplication
static const std::string & s_class_name
 
static const std::string s_source_id = "source_id"
 
static const std::string s_queue_rules = "queue_rules"
 
static const std::string s_network_rules = "network_rules"
 
static const std::string s_action_plans = "action_plans"
 
- Static Public Attributes inherited from dunedaq::confmodel::Application
static const std::string & s_class_name
 
static const std::string s_application_name = "application_name"
 
static const std::string s_commandline_parameters = "commandline_parameters"
 
static const std::string s_log_path = "log_path"
 
static const std::string s_application_environment = "application_environment"
 
static const std::string s_runs_on = "runs_on"
 
static const std::string s_exposes_service = "exposes_service"
 
static const std::string s_opmon_conf = "opmon_conf"
 

Protected Member Functions

 DFApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DFApplication () 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
 
 DFApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~DFApplication () 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::confmodel::Resource
 Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Resource () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Resource (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Resource () noexcept
 
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::confmodel::ResourceBase
 ResourceBase (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceBase () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 ResourceBase (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~ResourceBase () noexcept
 
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::confmodel::Component
 Component (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Component () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Component (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Component () noexcept
 
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.
 
- Protected Member Functions inherited from dunedaq::appmodel::SmartDaqApplication
 SmartDaqApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~SmartDaqApplication () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 SmartDaqApplication (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~SmartDaqApplication () noexcept
 
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::confmodel::Application
 Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Application () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 
 Application (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~Application () noexcept
 
bool get (const std::string &name, std::vector< const dunedaq::conffwk::DalObject * > &vec, bool upcast_unregistered, bool first_call) const
 

Private Attributes

const dunedaq::appmodel::TRBConfm_trb
 
std::vector< const dunedaq::appmodel::DataWriterConf * > m_data_writers
 
const dunedaq::appmodel::DFHWConfm_uses
 

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
 
DalRegistryp_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 39 of file DFApplication.hpp.

Constructor & Destructor Documentation

◆ DFApplication() [1/2]

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

Definition at line 33 of file DFApplication.cpp.

33 :
37 m_trb (nullptr),
38 m_uses (nullptr)
39
40 {
41 ;
42 }
const dunedaq::appmodel::TRBConf * m_trb
const dunedaq::appmodel::DFHWConf * m_uses
SmartDaqApplication(conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
The base class for any generated DAL object.
Definition DalObject.hpp:45

◆ ~DFApplication() [1/2]

dunedaq::appmodel::DFApplication::~DFApplication ( )
protectedvirtualnoexcept

Definition at line 91 of file DFApplication.cpp.

92 {
93 }

◆ DFApplication() [2/2]

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

◆ ~DFApplication() [2/2]

virtual dunedaq::appmodel::DFApplication::~DFApplication ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_data_writers_str() [1/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_data_writers_str ( )
inlinestaticnoexcept

Definition at line 104 of file DFApplication.hpp.

104{ return s_data_writers; }
static const std::string s_data_writers

◆ __get_data_writers_str() [2/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_data_writers_str ( )
inlinestaticnoexcept

Definition at line 104 of file DFApplication.hpp.

104{ return s_data_writers; }

◆ __get_trb_str() [1/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_trb_str ( )
inlinestaticnoexcept

Definition at line 103 of file DFApplication.hpp.

103{ return s_trb; }
static const std::string s_trb

◆ __get_trb_str() [2/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_trb_str ( )
inlinestaticnoexcept

Definition at line 103 of file DFApplication.hpp.

103{ return s_trb; }

◆ __get_uses_str() [1/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_uses_str ( )
inlinestaticnoexcept

Definition at line 105 of file DFApplication.hpp.

105{ return s_uses; }
static const std::string s_uses

◆ __get_uses_str() [2/2]

static const std::string & dunedaq::appmodel::DFApplication::__get_uses_str ( )
inlinestaticnoexcept

Definition at line 105 of file DFApplication.hpp.

105{ return s_uses; }

◆ generate_modules() [1/2]

std::vector< const confmodel::DaqModule * > dunedaq::appmodel::DFApplication::generate_modules ( const confmodel::Session * session) const
overridevirtual

Generate DaqModule dal objects for streams of the application on the fly

Reimplemented from dunedaq::appmodel::SmartDaqApplication.

Definition at line 198 of file DFApplication.cpp.

199{
200
201 ConfigObjectFactory obj_fac(this);
202
203 std::vector<const confmodel::DaqModule*> modules;
204
205 // Containers for module specific config objects for output/input
206 // Prepare TRB output objects
207 std::vector<const conffwk::ConfigObject*> trbOutputObjs;
208 std::vector<const conffwk::ConfigObject*> trbSidNetObjs;
209
210 // -- First, we process expected Queue and Network connections and create their objects.
211
212 // Process the queue rules looking for the TriggerRecord queue between TRB and DataWriterModule
213 const QueueDescriptor* trQDesc = nullptr;
214 for (auto rule : get_queue_rules()) {
215 auto destination_class = rule->get_destination_class();
216 if (destination_class == "DataWriterModule") {
217 trQDesc = rule->get_descriptor();
218 }
219 }
220 if (trQDesc == nullptr) { // BadConf if no descriptor between TRB and DataWriterModule
221 throw(BadConf(ERS_HERE, "Could not find queue descriptor rule for TriggerRecords!"));
222 }
223 // Create queue connection config object
224 auto trQueueObj = obj_fac.create_queue_obj(trQDesc, UID());
225
226 // Place trigger record queue object into vector of output objs of TRB module
227 trbOutputObjs.push_back(&trQueueObj);
228
229 // Process the network rules looking for the Fragments and TriggerDecision inputs for TRB
230 const NetworkConnectionDescriptor* fragNetDesc = nullptr;
231 const NetworkConnectionDescriptor* trigdecNetDesc = nullptr;
232 const NetworkConnectionDescriptor* tokenNetDesc = nullptr;
233 for (auto rule : get_network_rules()) {
234 auto descriptor = rule->get_descriptor();
235 auto data_type = descriptor->get_data_type();
236 if (data_type == "Fragment") {
237 fragNetDesc = rule->get_descriptor();
238 } else if (data_type == "TriggerDecision") {
239 trigdecNetDesc = rule->get_descriptor();
240 } else if (data_type == "TriggerDecisionToken") {
241 tokenNetDesc = rule->get_descriptor();
242 }
243 }
244 if (fragNetDesc == nullptr) { // BadConf if no descriptor for Fragments into TRB
245 throw(BadConf(ERS_HERE, "Could not find network descriptor rule for input Fragments!"));
246 }
247 if (trigdecNetDesc == nullptr) { // BadCond if no descriptor for TriggerDecisions into TRB
248 throw(BadConf(ERS_HERE, "Could not find network descriptor rule for input TriggerDecisions!"));
249 }
250 if (tokenNetDesc == nullptr) { // BadCond if no descriptor for Tokens out of DataWriterModule
251 throw(BadConf(ERS_HERE, "Could not find network descriptor rule for output TriggerDecisionTokens!"));
252 }
253 if (get_source_id() == nullptr) {
254 throw(BadConf(ERS_HERE, "Could not retrieve SourceIDConf"));
255 }
256 // Create network connection config object
257 auto fragNetObj = obj_fac.create_net_obj(fragNetDesc, UID());
258 auto trigdecNetObj = obj_fac.create_net_obj(trigdecNetDesc, UID());
259 auto tokenNetObj = obj_fac.create_net_obj(tokenNetDesc, "");
260
261 // Process special Network rules!
262 // Looking for DataRequest rules from ReadoutAppplications in current Session
263 auto sessionApps = session->get_enabled_applications();
264 std::vector<conffwk::ConfigObject> dreqNetObjs;
265 std::vector<conffwk::ConfigObject> sidNetObjs;
266 std::vector<std::shared_ptr<conffwk::ConfigObject>> sidObjs;
267 for (auto app : sessionApps) {
268 auto smartapp = app->cast<appmodel::SmartDaqApplication>();
269 auto roapp = app->cast<appmodel::ReadoutApplication>();
270 auto fdapp = app->cast<appmodel::FakeDataApplication>();
271 auto ctbapp = app->cast<appmodel::CTBApplication>();
272 auto dfapp = app->cast<appmodel::DFApplication>();
273 auto rapp = app->cast<appmodel::TPReplayApplication>();
274 if (smartapp == nullptr || dfapp != nullptr) {
275 continue;
276 }
277 auto src_id_check = smartapp->get_source_id();
278 if (roapp == nullptr
279 && fdapp == nullptr
280 && src_id_check == nullptr
281 && rapp == nullptr
282 && ctbapp == nullptr) {
283 continue;
284 }
285
286 auto roQRules = smartapp->get_network_rules();
287 for (auto rule : roQRules) {
288 auto descriptor = rule->get_descriptor();
289 auto data_type = descriptor->get_data_type();
290 if (data_type == "DataRequest") {
291 if (rapp != nullptr) {
292 fill_sourceid_object_from_app(obj_fac, rapp, &dreqNetObjs, &sidNetObjs, sidObjs, descriptor, smartapp->UID());
293 }
294 // contrary to all the other applications
295 // the CTB has 2 network connections, so this logic has to be splitted
296 else if (ctbapp) {
297 auto sources = ctbapp->get_sources();
298 for ( const auto & s : sources ) {
299 std::string dreqNetUid(descriptor->get_uid_base() + smartapp->UID()+ '_' + s.first);
300 dreqNetObjs.emplace_back( obj_fac.create_net_obj(descriptor, dreqNetUid) );
301
302 std::string sidToNetUid(descriptor->get_uid_base() + smartapp->UID() + "_" + s.first);
303 sidNetObjs.emplace_back( obj_fac.create("SourceIDToNetworkConnection", sidToNetUid ) );
304 sidNetObjs.back().set_obj("netconn", & dreqNetObjs.back());
305 sidNetObjs.back().set_objs("source_ids", { & s.second->config_object() });
306 } // loop over CTB sources
307 } else {
308
309 dreqNetObjs.emplace_back(obj_fac.create_net_obj(descriptor, smartapp->UID()));
310
311 std::string sidToNetUid(descriptor->get_uid_base() + smartapp->UID() + "-sids");
312 sidNetObjs.emplace_back(
313 obj_fac.create("SourceIDToNetworkConnection", sidToNetUid));
314 if (roapp != nullptr) {
315 fill_sourceid_object_from_app(obj_fac, roapp, &dreqNetObjs.back(), sidNetObjs.back(), sidObjs);
316 } else if (fdapp != nullptr) {
317 fill_sourceid_object_from_app(obj_fac, fdapp, &dreqNetObjs.back(), sidNetObjs.back(), sidObjs);
318 } else {
319 fill_sourceid_object_from_app(smartapp, &dreqNetObjs.back(), sidNetObjs.back());
320 }
321 } // else from if (ctbapp)
322 } // If network rule has DataRequest type of data
323 } // Loop over Apps network rules
324 } // loop over Session specific Apps
325
326 // Get pointers to objects here, after vector has been filled so they don't move on us
327 for (auto& obj : dreqNetObjs) {
328 trbOutputObjs.push_back(&obj);
329 }
330 for (auto& obj : sidNetObjs) {
331 trbSidNetObjs.push_back(&obj);
332 }
333
334 // -- Second, we create the Module objects and assign their configs, with the precreated
335 // -- connection config objects above.
336
337 // Get TRB Config Object
338 auto trbConf = get_trb();
339 if (trbConf == nullptr) {
340 throw(BadConf(ERS_HERE, "No DataWriterModule or TRB configuration given"));
341 }
342 auto trbConfObj = trbConf->config_object();
343 trbConfObj.set_by_val<uint32_t>("source_id", get_source_id()->get_sid());
344 // Prepare TRB Module Object and assign its Config Object.
345 std::string trbUid(UID() + "-trb");
346 conffwk::ConfigObject trbObj = obj_fac.create("TRBModule", trbUid);
347 trbObj.set_obj("configuration", &trbConfObj);
348 trbObj.set_objs("inputs", { &trigdecNetObj, &fragNetObj });
349 trbObj.set_objs("outputs", trbOutputObjs);
350 trbObj.set_objs("request_connections", trbSidNetObjs);
351 // Push TRB Module Object from confdb
352 modules.push_back(obj_fac.get_dal<TRBModule>(trbUid));
353
354 // Get DataWriterModule Config Object (only one for now, maybe more later?)
355 auto dwrConfs = get_data_writers();
356 if (dwrConfs.size() == 0) {
357 throw(BadConf(ERS_HERE, "No DataWriterModule or TRB configuration given"));
358 }
359 uint dw_idx = 0;
360 for (auto dwrConf : dwrConfs) {
361 // auto fnParamsObj = dwrConf->get_data_store_params()->get_filename_params()->config_object();
362 // fnParamsObj.set_by_val<std::string>("writer_identifier", fmt::format("{}_datawriter-{}", UID(), dw_idx));
363 auto dwrConfObj = dwrConf->config_object();
364
365 // Prepare DataWriterModule Module Object and assign its Config Object.
366 std::string dwrUid(fmt::format("{}-dw-{}", UID(), dw_idx));
367 conffwk::ConfigObject dwrObj = obj_fac.create("DataWriterModule", dwrUid);
368 dwrObj.set_by_val("writer_identifier", fmt::format("{}_dw_{}", UID(), dw_idx));
369 dwrObj.set_obj("configuration", &dwrConfObj);
370 dwrObj.set_objs("inputs", { &trQueueObj });
371 dwrObj.set_objs("outputs", { &tokenNetObj });
372 // Push DataWriterModule Module Object from confdb
373 modules.push_back(obj_fac.get_dal<DataWriterModule>(dwrUid));
374 ++dw_idx;
375 }
376
377 return modules;
378}
#define ERS_HERE
const std::vector< const dunedaq::appmodel::DataWriterConf * > & get_data_writers() const
Get "data_writers" relationship value.
const dunedaq::appmodel::TRBConf * get_trb() const
Get "trb" relationship value. Configuration of the TRB to be generated my get_modules()
const std::vector< const dunedaq::appmodel::NetworkConnectionRule * > & get_network_rules() const
Get "network_rules" relationship value.
const std::vector< const dunedaq::appmodel::QueueConnectionRule * > & get_queue_rules() const
Get "queue_rules" relationship value.
const dunedaq::appmodel::SourceIDConf * get_source_id() const
Get "source_id" relationship value.
uint32_t get_sid() const
Get "sid" attribute value.
const std::string & UID() const noexcept
void fill_sourceid_object_from_app(const SmartDaqApplication *smartapp, const conffwk::ConfigObject *netConn, conffwk::ConfigObject &sidNetObj)

◆ generate_modules() [2/2]

std::vector< const dunedaq::confmodel::DaqModule * > dunedaq::appmodel::DFApplication::generate_modules ( const confmodel::Session * ) const
overridevirtual

Generate DaqModule dal objects for streams of the application on the fly

Reimplemented from dunedaq::appmodel::SmartDaqApplication.

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::DFApplication::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
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::Resource.

Definition at line 95 of file DFApplication.cpp.

96 {
97 std::vector<const dunedaq::conffwk::DalObject *> vec;
98
99 if (!get(name, vec, upcast_unregistered, true))
100 throw_get_ex(name, s_class_name, this);
101
102 return vec;
103 }
static const std::string & s_class_name
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...
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.
Definition DalObject.cpp:82

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::appmodel::DFApplication::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
namename of the relationship or algorithm
Returns
value of relationship or result of algorithm
Exceptions
std::exceptionif there is no relationship or algorithm with such name in this and base classes

Reimplemented from dunedaq::confmodel::Resource.

◆ get() [3/4]

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

Definition at line 105 of file DFApplication.cpp.

106 {
107 if (first_call)
108 {
109 std::lock_guard scoped_lock(m_mutex);
110
111 check();
112 check_init();
113
114 if (get_rel_objects(name, upcast_unregistered, vec))
115 return true;
116 }
117
118 if (Resource::get(name, vec, upcast_unregistered, false)) return true;
119 if (SmartDaqApplication::get(name, vec, upcast_unregistered, false)) return true;
120
121 if (first_call)
122 return get_algo_objects(name, vec);
123
124 return false;
125 }
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...
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.
Definition DalObject.cpp:8
std::mutex m_mutex
Used to protect changes of DAL object.
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.
Definition DalObject.cpp:25
void check_init() const
Check and initialize object if necessary.

◆ get() [4/4]

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

◆ get_data_writers() [1/2]

const std::vector< const dunedaq::appmodel::DataWriterConf * > & dunedaq::appmodel::DFApplication::get_data_writers ( ) const
inline

Get "data_writers" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 148 of file DFApplication.hpp.

149 {
150 std::lock_guard scoped_lock(m_mutex);
151 check();
152 check_init();
153 if (m_data_writers.empty())
154 {
155 std::ostringstream text;
156 text << "relationship \"" << s_data_writers << "\" of object " << this << " is empty";
157 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
158 }
159 return m_data_writers;
160 }
std::vector< const dunedaq::appmodel::DataWriterConf * > m_data_writers
Generic configuration exception.

◆ get_data_writers() [2/2]

const std::vector< const dunedaq::appmodel::DataWriterConf * > & dunedaq::appmodel::DFApplication::get_data_writers ( ) const
inline

Get "data_writers" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 148 of file DFApplication.hpp.

149 {
150 std::lock_guard scoped_lock(m_mutex);
151 check();
152 check_init();
153 if (m_data_writers.empty())
154 {
155 std::ostringstream text;
156 text << "relationship \"" << s_data_writers << "\" of object " << this << " is empty";
157 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
158 }
159 return m_data_writers;
160 }

◆ get_trb() [1/2]

const dunedaq::appmodel::TRBConf * dunedaq::appmodel::DFApplication::get_trb ( ) const
inline

Get "trb" relationship value. Configuration of the TRB to be generated my get_modules()

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 116 of file DFApplication.hpp.

117 {
118 std::lock_guard scoped_lock(m_mutex);
119 check();
120 check_init();
121 if (!m_trb)
122 {
123 std::ostringstream text;
124 text << "relationship \"" << s_trb << "\" of object " << this << " is not set";
125 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
126 }
127 return m_trb;
128 }

◆ get_trb() [2/2]

const dunedaq::appmodel::TRBConf * dunedaq::appmodel::DFApplication::get_trb ( ) const
inline

Get "trb" relationship value. Configuration of the TRB to be generated my get_modules()

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 116 of file DFApplication.hpp.

117 {
118 std::lock_guard scoped_lock(m_mutex);
119 check();
120 check_init();
121 if (!m_trb)
122 {
123 std::ostringstream text;
124 text << "relationship \"" << s_trb << "\" of object " << this << " is not set";
125 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
126 }
127 return m_trb;
128 }

◆ get_uses() [1/2]

const dunedaq::appmodel::DFHWConf * dunedaq::appmodel::DFApplication::get_uses ( ) const
inline

Get "uses" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 179 of file DFApplication.hpp.

180 {
181 std::lock_guard scoped_lock(m_mutex);
182 check();
183 check_init();
184 if (!m_uses)
185 {
186 std::ostringstream text;
187 text << "relationship \"" << s_uses << "\" of object " << this << " is not set";
188 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
189 }
190 return m_uses;
191 }

◆ get_uses() [2/2]

const dunedaq::appmodel::DFHWConf * dunedaq::appmodel::DFApplication::get_uses ( ) const
inline

Get "uses" relationship value.

Returns
the relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 179 of file DFApplication.hpp.

180 {
181 std::lock_guard scoped_lock(m_mutex);
182 check();
183 check_init();
184 if (!m_uses)
185 {
186 std::ostringstream text;
187 text << "relationship \"" << s_uses << "\" of object " << this << " is not set";
188 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
189 }
190 return m_uses;
191 }

◆ init() [1/2]

void dunedaq::appmodel::DFApplication::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Resource.

Definition at line 74 of file DFApplication.cpp.

75 {
76 Resource::init(init_children);
77 SmartDaqApplication::init(init_children);
78
79 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
80
81 try {
85 }
86 catch (dunedaq::conffwk::Exception & ex) {
87 throw_init_ex(ex);
88 }
89 }
virtual void init(bool init_children)
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
DalRegistry & p_registry
Configuration object.
ConfigObject p_obj
Config object used by given template object.
const T * _ref(ConfigObject &obj, const std::string &name, bool read_children)
Get signle value of object's relation and instantiate result with it (multi-thread safe).
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::appmodel::DFApplication::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Reimplemented from dunedaq::confmodel::Resource.

◆ print() [1/2]

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

Print details of the DFApplication object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::Resource.

Definition at line 45 of file DFApplication.cpp.

46 {
47 check_init();
48
49 try {
50 const std::string str(indent+2, ' ');
51
52 if (print_header)
53 p_hdr(s, indent, s_class_name, "dunedaq::appmodel");
54
55
56 // print direct super-classes
57
60
61
62 // print direct relationships
63
67 }
68 catch (dunedaq::conffwk::Exception & ex) {
70 }
71 }
virtual void print(unsigned int offset, bool print_header, std::ostream &s) const
Print details of the SmartDaqApplication object.
void p_hdr(std::ostream &s, unsigned int indent, const std::string &cl, const char *nm=nullptr) const
print object headers
Definition DalObject.cpp:65
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
virtual void print(unsigned int offset, bool print_header, std::ostream &s) const
Print details of the Resource object.
Definition Resource.cpp:35
void p_sv_rel(std::ostream &s, const std::string &str, const std::string &name, const DalObject *obj)
print weak single-value relationship
void p_mv_rel(std::ostream &s, const std::string &str, const std::string &name, const T &objs) noexcept
print weak multi-value relationship

◆ print() [2/2]

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

Print details of the DFApplication object.

Parameters are:

Parameters
offsetnumber of spaces to shift object right (useful to print nested objects)
print_headerif false, do not print object header (to print attributes of base classes)
soutput stream

Reimplemented from dunedaq::confmodel::Resource.

◆ set_data_writers() [1/2]

void dunedaq::appmodel::DFApplication::set_data_writers ( const std::vector< const dunedaq::appmodel::DataWriterConf * > & value)

Set "data_writers" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 132 of file DFApplication.cpp.

133 {
135 }
void _set_objects(const std::string &name, const std::vector< const T * > &value)
Helper method for generated set multi-value relationship methods.

◆ set_data_writers() [2/2]

void dunedaq::appmodel::DFApplication::set_data_writers ( const std::vector< const dunedaq::appmodel::DataWriterConf * > & value)

Set "data_writers" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

◆ set_trb() [1/2]

void dunedaq::appmodel::DFApplication::set_trb ( const dunedaq::appmodel::TRBConf * value)

Set "trb" relationship value. Configuration of the TRB to be generated my get_modules()

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 127 of file DFApplication.cpp.

128 {
129 _set_object(s_trb, value);
130 }
void _set_object(const std::string &name, const T *value)
Helper method for generated set single-value relationship methods.

◆ set_trb() [2/2]

void dunedaq::appmodel::DFApplication::set_trb ( const dunedaq::appmodel::TRBConf * value)

Set "trb" relationship value. Configuration of the TRB to be generated my get_modules()

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

◆ set_uses() [1/2]

void dunedaq::appmodel::DFApplication::set_uses ( const dunedaq::appmodel::DFHWConf * value)

Set "uses" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Definition at line 137 of file DFApplication.cpp.

138 {
139 _set_object(s_uses, value);
140 }

◆ set_uses() [2/2]

void dunedaq::appmodel::DFApplication::set_uses ( const dunedaq::appmodel::DFHWConf * value)

Set "uses" relationship value.

Parameters
valuenew relationship value
Exceptions
dunedaq::conffwk::Generic,dunedaq::conffwk::DeletedObject

Friends And Related Symbol Documentation

◆ conffwk::Configuration

Definition at line 41 of file DFApplication.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 43 of file DFApplication.hpp.

◆ conffwk::DalObject

Definition at line 42 of file DFApplication.hpp.

◆ conffwk::DalRegistry

Definition at line 44 of file DFApplication.hpp.

Member Data Documentation

◆ m_data_writers

std::vector< const dunedaq::appmodel::DataWriterConf * > dunedaq::appmodel::DFApplication::m_data_writers
private

Definition at line 91 of file DFApplication.hpp.

◆ m_trb

const dunedaq::appmodel::TRBConf * dunedaq::appmodel::DFApplication::m_trb
private

Definition at line 90 of file DFApplication.hpp.

◆ m_uses

const dunedaq::appmodel::DFHWConf * dunedaq::appmodel::DFApplication::m_uses
private

Definition at line 92 of file DFApplication.hpp.

◆ s_class_name

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

The name of the configuration class.

Definition at line 56 of file DFApplication.hpp.

◆ s_data_writers

static const std::string dunedaq::appmodel::DFApplication::s_data_writers = "data_writers"
inlinestatic

Definition at line 100 of file DFApplication.hpp.

◆ s_trb

static const std::string dunedaq::appmodel::DFApplication::s_trb = "trb"
inlinestatic

Definition at line 99 of file DFApplication.hpp.

◆ s_uses

static const std::string dunedaq::appmodel::DFApplication::s_uses = "uses"
inlinestatic

Definition at line 101 of file DFApplication.hpp.


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