DUNE-DAQ
DUNE Trigger and Data Acquisition software
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | Friends | List of all members
dunedaq::confmodel::FSMconfiguration Class Reference

#include <FSMconfiguration.hpp>

Inheritance diagram for dunedaq::confmodel::FSMconfiguration:
[legend]
Collaboration diagram for dunedaq::confmodel::FSMconfiguration:
[legend]

Public Member Functions

virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the FSMconfiguration 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::vector< std::string > & get_states () const
 Get "states" attribute value.
 
void set_states (const std::vector< std::string > &value)
 Set "states" attribute value.
 
const std::string & get_initial_state () const
 Get "initial_state" attribute value.
 
void set_initial_state (const std::string &value)
 Set "initial_state" attribute value.
 
const std::vector< const dunedaq::confmodel::FSMtransition * > & get_transitions () const
 Get "transitions" relationship value.
 
void set_transitions (const std::vector< const dunedaq::confmodel::FSMtransition * > &value)
 Set "transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMsequence * > & get_command_sequences () const
 Get "command_sequences" relationship value.
 
void set_command_sequences (const std::vector< const dunedaq::confmodel::FSMsequence * > &value)
 Set "command_sequences" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMxTransition * > & get_pre_transitions () const
 Get "pre_transitions" relationship value.
 
void set_pre_transitions (const std::vector< const dunedaq::confmodel::FSMxTransition * > &value)
 Set "pre_transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMxTransition * > & get_post_transitions () const
 Get "post_transitions" relationship value.
 
void set_post_transitions (const std::vector< const dunedaq::confmodel::FSMxTransition * > &value)
 Set "post_transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMaction * > & get_actions () const
 Get "actions" relationship value.
 
void set_actions (const std::vector< const dunedaq::confmodel::FSMaction * > &value)
 Set "actions" relationship value.
 
virtual void print (unsigned int offset, bool print_header, std::ostream &s) const
 Print details of the FSMconfiguration 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::vector< std::string > & get_states () const
 Get "states" attribute value.
 
void set_states (const std::vector< std::string > &value)
 Set "states" attribute value.
 
const std::string & get_initial_state () const
 Get "initial_state" attribute value.
 
void set_initial_state (const std::string &value)
 Set "initial_state" attribute value.
 
const std::vector< const dunedaq::confmodel::FSMtransition * > & get_transitions () const
 Get "transitions" relationship value.
 
void set_transitions (const std::vector< const dunedaq::confmodel::FSMtransition * > &value)
 Set "transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMsequence * > & get_command_sequences () const
 Get "command_sequences" relationship value.
 
void set_command_sequences (const std::vector< const dunedaq::confmodel::FSMsequence * > &value)
 Set "command_sequences" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMxTransition * > & get_pre_transitions () const
 Get "pre_transitions" relationship value.
 
void set_pre_transitions (const std::vector< const dunedaq::confmodel::FSMxTransition * > &value)
 Set "pre_transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMxTransition * > & get_post_transitions () const
 Get "post_transitions" relationship value.
 
void set_post_transitions (const std::vector< const dunedaq::confmodel::FSMxTransition * > &value)
 Set "post_transitions" relationship value.
 
const std::vector< const dunedaq::confmodel::FSMaction * > & get_actions () const
 Get "actions" relationship value.
 
void set_actions (const std::vector< const dunedaq::confmodel::FSMaction * > &value)
 Set "actions" 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_states_str () noexcept
 
static const std::string & __get_initial_state_str () noexcept
 
static const std::string & __get_transitions_str () noexcept
 
static const std::string & __get_command_sequences_str () noexcept
 
static const std::string & __get_pre_transitions_str () noexcept
 
static const std::string & __get_post_transitions_str () noexcept
 
static const std::string & __get_actions_str () noexcept
 
static const std::string & __get_states_str () noexcept
 
static const std::string & __get_initial_state_str () noexcept
 
static const std::string & __get_transitions_str () noexcept
 
static const std::string & __get_command_sequences_str () noexcept
 
static const std::string & __get_pre_transitions_str () noexcept
 
static const std::string & __get_post_transitions_str () noexcept
 
static const std::string & __get_actions_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_states = "states"
 
static const std::string s_initial_state = "initial_state"
 
static const std::string s_transitions = "transitions"
 
static const std::string s_command_sequences = "command_sequences"
 
static const std::string s_pre_transitions = "pre_transitions"
 
static const std::string s_post_transitions = "post_transitions"
 
static const std::string s_actions = "actions"
 

Protected Member Functions

 FSMconfiguration (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~FSMconfiguration () 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
 
 FSMconfiguration (conffwk::DalRegistry &db, const conffwk::ConfigObject &obj) noexcept
 
virtual ~FSMconfiguration () 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::vector< std::string > m_states
 
std::string m_initial_state
 
std::vector< const dunedaq::confmodel::FSMtransition * > m_transitions
 
std::vector< const dunedaq::confmodel::FSMsequence * > m_command_sequences
 
std::vector< const dunedaq::confmodel::FSMxTransition * > m_pre_transitions
 
std::vector< const dunedaq::confmodel::FSMxTransition * > m_post_transitions
 
std::vector< const dunedaq::confmodel::FSMaction * > m_actions
 

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 32 of file FSMconfiguration.hpp.

Constructor & Destructor Documentation

◆ FSMconfiguration() [1/2]

dunedaq::confmodel::FSMconfiguration::FSMconfiguration ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

Definition at line 34 of file FSMconfiguration.cpp.

34 :
35 dunedaq::conffwk::DalObject(db, o)
36 {
37 ;
38 }
dunedaq::conffwk::DalObject
The base class for any generated DAL object.
Definition DalObject.hpp:45

◆ ~FSMconfiguration() [1/2]

dunedaq::confmodel::FSMconfiguration::~FSMconfiguration ( )
protectedvirtualnoexcept

Definition at line 92 of file FSMconfiguration.cpp.

93 {
94 }

◆ FSMconfiguration() [2/2]

dunedaq::confmodel::FSMconfiguration::FSMconfiguration ( conffwk::DalRegistry & db,
const conffwk::ConfigObject & obj )
protectednoexcept

◆ ~FSMconfiguration() [2/2]

virtual dunedaq::confmodel::FSMconfiguration::~FSMconfiguration ( )
protectedvirtualnoexcept

Member Function Documentation

◆ __get_actions_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_actions_str ( )
inlinestaticnoexcept

Definition at line 177 of file FSMconfiguration.hpp.

177{ return s_actions; }

◆ __get_actions_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_actions_str ( )
inlinestaticnoexcept

Definition at line 177 of file FSMconfiguration.hpp.

177{ return s_actions; }

◆ __get_command_sequences_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_command_sequences_str ( )
inlinestaticnoexcept

Definition at line 174 of file FSMconfiguration.hpp.

174{ return s_command_sequences; }
dunedaq::confmodel::FSMconfiguration::s_command_sequences
static const std::string s_command_sequences
Definition FSMconfiguration.hpp:168

◆ __get_command_sequences_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_command_sequences_str ( )
inlinestaticnoexcept

Definition at line 174 of file FSMconfiguration.hpp.

174{ return s_command_sequences; }

◆ __get_initial_state_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_initial_state_str ( )
inlinestaticnoexcept

Definition at line 100 of file FSMconfiguration.hpp.

100{ return s_initial_state; }
dunedaq::confmodel::FSMconfiguration::s_initial_state
static const std::string s_initial_state
Definition FSMconfiguration.hpp:97

◆ __get_initial_state_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_initial_state_str ( )
inlinestaticnoexcept

Definition at line 100 of file FSMconfiguration.hpp.

100{ return s_initial_state; }

◆ __get_post_transitions_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_post_transitions_str ( )
inlinestaticnoexcept

Definition at line 176 of file FSMconfiguration.hpp.

176{ return s_post_transitions; }
dunedaq::confmodel::FSMconfiguration::s_post_transitions
static const std::string s_post_transitions
Definition FSMconfiguration.hpp:170

◆ __get_post_transitions_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_post_transitions_str ( )
inlinestaticnoexcept

Definition at line 176 of file FSMconfiguration.hpp.

176{ return s_post_transitions; }

◆ __get_pre_transitions_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_pre_transitions_str ( )
inlinestaticnoexcept

Definition at line 175 of file FSMconfiguration.hpp.

175{ return s_pre_transitions; }
dunedaq::confmodel::FSMconfiguration::s_pre_transitions
static const std::string s_pre_transitions
Definition FSMconfiguration.hpp:169

◆ __get_pre_transitions_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_pre_transitions_str ( )
inlinestaticnoexcept

Definition at line 175 of file FSMconfiguration.hpp.

175{ return s_pre_transitions; }

◆ __get_states_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_states_str ( )
inlinestaticnoexcept

Definition at line 99 of file FSMconfiguration.hpp.

99{ return s_states; }

◆ __get_states_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_states_str ( )
inlinestaticnoexcept

Definition at line 99 of file FSMconfiguration.hpp.

99{ return s_states; }

◆ __get_transitions_str() [1/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_transitions_str ( )
inlinestaticnoexcept

Definition at line 173 of file FSMconfiguration.hpp.

173{ return s_transitions; }

◆ __get_transitions_str() [2/2]

static const std::string & dunedaq::confmodel::FSMconfiguration::__get_transitions_str ( )
inlinestaticnoexcept

Definition at line 173 of file FSMconfiguration.hpp.

173{ return s_transitions; }

◆ get() [1/4]

std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::FSMconfiguration::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

Implements dunedaq::conffwk::DalObject.

Definition at line 96 of file FSMconfiguration.cpp.

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

◆ get() [2/4]

virtual std::vector< const dunedaq::conffwk::DalObject * > dunedaq::confmodel::FSMconfiguration::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

Implements dunedaq::conffwk::DalObject.

◆ get() [3/4]

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

Definition at line 106 of file FSMconfiguration.cpp.

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

◆ get() [4/4]

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

◆ get_actions() [1/2]

const std::vector< const dunedaq::confmodel::FSMaction * > & dunedaq::confmodel::FSMconfiguration::get_actions ( ) const
inline

Get "actions" relationship value.

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

Definition at line 293 of file FSMconfiguration.hpp.

294 {
295 std::lock_guard scoped_lock(m_mutex);
296 check();
297 check_init();
298 return m_actions;
299 }
dunedaq::confmodel::FSMconfiguration::m_actions
std::vector< const dunedaq::confmodel::FSMaction * > m_actions
Definition FSMconfiguration.hpp:89

◆ get_actions() [2/2]

const std::vector< const dunedaq::confmodel::FSMaction * > & dunedaq::confmodel::FSMconfiguration::get_actions ( ) const
inline

Get "actions" relationship value.

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

Definition at line 293 of file FSMconfiguration.hpp.

294 {
295 std::lock_guard scoped_lock(m_mutex);
296 check();
297 check_init();
298 return m_actions;
299 }

◆ get_command_sequences() [1/2]

const std::vector< const dunedaq::confmodel::FSMsequence * > & dunedaq::confmodel::FSMconfiguration::get_command_sequences ( ) const
inline

Get "command_sequences" relationship value.

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

Definition at line 218 of file FSMconfiguration.hpp.

219 {
220 std::lock_guard scoped_lock(m_mutex);
221 check();
222 check_init();
223 return m_command_sequences;
224 }
dunedaq::confmodel::FSMconfiguration::m_command_sequences
std::vector< const dunedaq::confmodel::FSMsequence * > m_command_sequences
Definition FSMconfiguration.hpp:86

◆ get_command_sequences() [2/2]

const std::vector< const dunedaq::confmodel::FSMsequence * > & dunedaq::confmodel::FSMconfiguration::get_command_sequences ( ) const
inline

Get "command_sequences" relationship value.

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

Definition at line 218 of file FSMconfiguration.hpp.

219 {
220 std::lock_guard scoped_lock(m_mutex);
221 check();
222 check_init();
223 return m_command_sequences;
224 }

◆ get_initial_state() [1/2]

const std::string & dunedaq::confmodel::FSMconfiguration::get_initial_state ( ) const
inline

Get "initial_state" attribute value.

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

Definition at line 141 of file FSMconfiguration.hpp.

142 {
143 std::lock_guard scoped_lock(m_mutex);
144 check();
145 check_init();
146 return m_initial_state;
147 }

◆ get_initial_state() [2/2]

const std::string & dunedaq::confmodel::FSMconfiguration::get_initial_state ( ) const
inline

Get "initial_state" attribute value.

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

Definition at line 141 of file FSMconfiguration.hpp.

142 {
143 std::lock_guard scoped_lock(m_mutex);
144 check();
145 check_init();
146 return m_initial_state;
147 }

◆ get_post_transitions() [1/2]

const std::vector< const dunedaq::confmodel::FSMxTransition * > & dunedaq::confmodel::FSMconfiguration::get_post_transitions ( ) const
inline

Get "post_transitions" relationship value.

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

Definition at line 268 of file FSMconfiguration.hpp.

269 {
270 std::lock_guard scoped_lock(m_mutex);
271 check();
272 check_init();
273 return m_post_transitions;
274 }
dunedaq::confmodel::FSMconfiguration::m_post_transitions
std::vector< const dunedaq::confmodel::FSMxTransition * > m_post_transitions
Definition FSMconfiguration.hpp:88

◆ get_post_transitions() [2/2]

const std::vector< const dunedaq::confmodel::FSMxTransition * > & dunedaq::confmodel::FSMconfiguration::get_post_transitions ( ) const
inline

Get "post_transitions" relationship value.

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

Definition at line 268 of file FSMconfiguration.hpp.

269 {
270 std::lock_guard scoped_lock(m_mutex);
271 check();
272 check_init();
273 return m_post_transitions;
274 }

◆ get_pre_transitions() [1/2]

const std::vector< const dunedaq::confmodel::FSMxTransition * > & dunedaq::confmodel::FSMconfiguration::get_pre_transitions ( ) const
inline

Get "pre_transitions" relationship value.

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

Definition at line 243 of file FSMconfiguration.hpp.

244 {
245 std::lock_guard scoped_lock(m_mutex);
246 check();
247 check_init();
248 return m_pre_transitions;
249 }
dunedaq::confmodel::FSMconfiguration::m_pre_transitions
std::vector< const dunedaq::confmodel::FSMxTransition * > m_pre_transitions
Definition FSMconfiguration.hpp:87

◆ get_pre_transitions() [2/2]

const std::vector< const dunedaq::confmodel::FSMxTransition * > & dunedaq::confmodel::FSMconfiguration::get_pre_transitions ( ) const
inline

Get "pre_transitions" relationship value.

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

Definition at line 243 of file FSMconfiguration.hpp.

244 {
245 std::lock_guard scoped_lock(m_mutex);
246 check();
247 check_init();
248 return m_pre_transitions;
249 }

◆ get_states() [1/2]

const std::vector< std::string > & dunedaq::confmodel::FSMconfiguration::get_states ( ) const
inline

Get "states" attribute value.

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

Definition at line 110 of file FSMconfiguration.hpp.

111 {
112 std::lock_guard scoped_lock(m_mutex);
113 check();
114 check_init();
115 return m_states;
116 }
dunedaq::confmodel::FSMconfiguration::m_states
std::vector< std::string > m_states
Definition FSMconfiguration.hpp:83

◆ get_states() [2/2]

const std::vector< std::string > & dunedaq::confmodel::FSMconfiguration::get_states ( ) const
inline

Get "states" attribute value.

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

Definition at line 110 of file FSMconfiguration.hpp.

111 {
112 std::lock_guard scoped_lock(m_mutex);
113 check();
114 check_init();
115 return m_states;
116 }

◆ get_transitions() [1/2]

const std::vector< const dunedaq::confmodel::FSMtransition * > & dunedaq::confmodel::FSMconfiguration::get_transitions ( ) const
inline

Get "transitions" relationship value.

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

Definition at line 187 of file FSMconfiguration.hpp.

188 {
189 std::lock_guard scoped_lock(m_mutex);
190 check();
191 check_init();
192 if (m_transitions.empty())
193 {
194 std::ostringstream text;
195 text << "relationship \"" << s_transitions << "\" of object " << this << " is empty";
196 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
197 }
198 return m_transitions;
199 }
ERS_HERE
#define ERS_HERE
Definition LocalContext.hpp:130
Generic
Generic configuration exception.
dunedaq::confmodel::FSMconfiguration::m_transitions
std::vector< const dunedaq::confmodel::FSMtransition * > m_transitions
Definition FSMconfiguration.hpp:85

◆ get_transitions() [2/2]

const std::vector< const dunedaq::confmodel::FSMtransition * > & dunedaq::confmodel::FSMconfiguration::get_transitions ( ) const
inline

Get "transitions" relationship value.

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

Definition at line 187 of file FSMconfiguration.hpp.

188 {
189 std::lock_guard scoped_lock(m_mutex);
190 check();
191 check_init();
192 if (m_transitions.empty())
193 {
194 std::ostringstream text;
195 text << "relationship \"" << s_transitions << "\" of object " << this << " is empty";
196 throw dunedaq::conffwk::Generic(ERS_HERE, text.str().c_str());
197 }
198 return m_transitions;
199 }

◆ init() [1/2]

void dunedaq::confmodel::FSMconfiguration::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

Definition at line 72 of file FSMconfiguration.cpp.

73 {
74 p_was_read = true;
75 increment_read();
76 TLOG_DEBUG(5) << "read object " << this << " (class " << s_class_name << ')';
77
78 try {
79 p_obj.get(s_states, m_states);
80 p_obj.get(s_initial_state, m_initial_state);
81 p_registry._ref<dunedaq::confmodel::FSMtransition>(p_obj, s_transitions, m_transitions, init_children);
82 p_registry._ref<dunedaq::confmodel::FSMsequence>(p_obj, s_command_sequences, m_command_sequences, init_children);
83 p_registry._ref<dunedaq::confmodel::FSMxTransition>(p_obj, s_pre_transitions, m_pre_transitions, init_children);
84 p_registry._ref<dunedaq::confmodel::FSMxTransition>(p_obj, s_post_transitions, m_post_transitions, init_children);
85 p_registry._ref<dunedaq::confmodel::FSMaction>(p_obj, s_actions, m_actions, init_children);
86 }
87 catch (dunedaq::conffwk::Exception & ex) {
88 throw_init_ex(ex);
89 }
90 }
dunedaq::conffwk::ConfigObject::get
void get(const std::string &name, T &value)
Get value of object's attribute or relationship.
Definition ConfigObject.hpp:278
dunedaq::conffwk::DalObject::throw_init_ex
void throw_init_ex(dunedaq::conffwk::Exception &ex)
throw object initialisation exception (i.e.
Definition DalObject.cpp:74
dunedaq::conffwk::DalObject::increment_read
void increment_read() noexcept
Definition DalObject.hpp:352
dunedaq::conffwk::DalObject::p_registry
DalRegistry & p_registry
Configuration object.
Definition DalObject.hpp:114
dunedaq::conffwk::DalObject::p_was_read
bool p_was_read
is true, if the object was read
Definition DalObject.hpp:111
dunedaq::conffwk::DalObject::p_obj
ConfigObject p_obj
Config object used by given template object.
Definition DalObject.hpp:117
dunedaq::conffwk::DalRegistry::_ref
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).
Definition DalRegistry.hxx:164
TLOG_DEBUG
#define TLOG_DEBUG(lvl,...)
Definition Logging.hpp:112

◆ init() [2/2]

virtual void dunedaq::confmodel::FSMconfiguration::init ( bool init_children)
protectedvirtual

Initialize object (method generated by genconffwk)

Parameters
init_childrenif true, initialize referenced objects

Implements dunedaq::conffwk::DalObject.

◆ print() [1/2]

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

Print details of the FSMconfiguration 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

Implements dunedaq::conffwk::DalObject.

Definition at line 41 of file FSMconfiguration.cpp.

42 {
43 check_init();
44
45 try {
46 const std::string str(indent+2, ' ');
47
48 if (print_header)
49 p_hdr(s, indent, s_class_name, "dunedaq::confmodel");
50
51
52 // print direct attributes
53
54 dunedaq::conffwk::p_mv_attr(s, str, s_states, m_states);
55 dunedaq::conffwk::p_sv_attr(s, str, s_initial_state, m_initial_state);
56
57
58 // print direct relationships
59
60 dunedaq::conffwk::p_mv_rel(s, str, indent, s_transitions, m_transitions);
61 dunedaq::conffwk::p_mv_rel(s, str, indent, s_command_sequences, m_command_sequences);
62 dunedaq::conffwk::p_mv_rel(s, str, indent, s_pre_transitions, m_pre_transitions);
63 dunedaq::conffwk::p_mv_rel(s, str, indent, s_post_transitions, m_post_transitions);
64 dunedaq::conffwk::p_mv_rel(s, str, indent, s_actions, m_actions);
65 }
66 catch (dunedaq::conffwk::Exception & ex) {
67 dunedaq::conffwk::DalObject::p_error(s, ex);
68 }
69 }
dunedaq::conffwk::DalObject::p_hdr
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
dunedaq::conffwk::DalObject::p_error
static void p_error(std::ostream &s, dunedaq::conffwk::Exception &ex)
print error text
Definition DalObject.cpp:59
dunedaq::conffwk::p_mv_rel
void p_mv_rel(std::ostream &s, const std::string &str, const std::string &name, const T &objs) noexcept
print weak multi-value relationship
Definition DalObjectPrint.hpp:114
dunedaq::conffwk::p_mv_attr
void p_mv_attr(std::ostream &s, const std::string &str, const std::string &name, const T &val) noexcept
print multi-value attribute
Definition DalObjectPrint.hpp:73
dunedaq::conffwk::p_sv_attr
void p_sv_attr(std::ostream &s, const std::string &str, const std::string &name, const T &val) noexcept
print single-value attribute
Definition DalObjectPrint.hpp:61

◆ print() [2/2]

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

Print details of the FSMconfiguration 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

Implements dunedaq::conffwk::DalObject.

◆ set_actions() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_actions ( const std::vector< const dunedaq::confmodel::FSMaction * > & value)

Set "actions" relationship value.

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

Definition at line 145 of file FSMconfiguration.cpp.

146 {
147 _set_objects(s_actions, value);
148 }
dunedaq::conffwk::DalObject::_set_objects
void _set_objects(const std::string &name, const std::vector< const T * > &value)
Helper method for generated set multi-value relationship methods.
Definition DalObject.hpp:428

◆ set_actions() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_actions ( const std::vector< const dunedaq::confmodel::FSMaction * > & value)

Set "actions" relationship value.

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

◆ set_command_sequences() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_command_sequences ( const std::vector< const dunedaq::confmodel::FSMsequence * > & value)

Set "command_sequences" relationship value.

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

Definition at line 130 of file FSMconfiguration.cpp.

131 {
132 _set_objects(s_command_sequences, value);
133 }

◆ set_command_sequences() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_command_sequences ( const std::vector< const dunedaq::confmodel::FSMsequence * > & value)

Set "command_sequences" relationship value.

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

◆ set_initial_state() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_initial_state ( const std::string & value)
inline

Set "initial_state" attribute value.

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

Definition at line 156 of file FSMconfiguration.hpp.

157 {
158 std::lock_guard scoped_lock(m_mutex);
159 check();
160 clear();
161 p_obj.set_by_ref(s_initial_state, value);
162 }
dunedaq::conffwk::ConfigObject::set_by_ref
void set_by_ref(const std::string &name, T &value)
Set attribute value.
Definition ConfigObject.hpp:412

◆ set_initial_state() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_initial_state ( const std::string & value)
inline

Set "initial_state" attribute value.

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

Definition at line 156 of file FSMconfiguration.hpp.

157 {
158 std::lock_guard scoped_lock(m_mutex);
159 check();
160 clear();
161 p_obj.set_by_ref(s_initial_state, value);
162 }

◆ set_post_transitions() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_post_transitions ( const std::vector< const dunedaq::confmodel::FSMxTransition * > & value)

Set "post_transitions" relationship value.

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

Definition at line 140 of file FSMconfiguration.cpp.

141 {
142 _set_objects(s_post_transitions, value);
143 }

◆ set_post_transitions() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_post_transitions ( const std::vector< const dunedaq::confmodel::FSMxTransition * > & value)

Set "post_transitions" relationship value.

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

◆ set_pre_transitions() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_pre_transitions ( const std::vector< const dunedaq::confmodel::FSMxTransition * > & value)

Set "pre_transitions" relationship value.

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

Definition at line 135 of file FSMconfiguration.cpp.

136 {
137 _set_objects(s_pre_transitions, value);
138 }

◆ set_pre_transitions() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_pre_transitions ( const std::vector< const dunedaq::confmodel::FSMxTransition * > & value)

Set "pre_transitions" relationship value.

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

◆ set_states() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_states ( const std::vector< std::string > & value)
inline

Set "states" attribute value.

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

Definition at line 125 of file FSMconfiguration.hpp.

126 {
127 std::lock_guard scoped_lock(m_mutex);
128 check();
129 clear();
130 p_obj.set_by_val(s_states, value);
131 }
dunedaq::conffwk::ConfigObject::set_by_val
void set_by_val(const std::string &name, T value)
Set attribute value.
Definition ConfigObject.hpp:391

◆ set_states() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_states ( const std::vector< std::string > & value)
inline

Set "states" attribute value.

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

Definition at line 125 of file FSMconfiguration.hpp.

126 {
127 std::lock_guard scoped_lock(m_mutex);
128 check();
129 clear();
130 p_obj.set_by_val(s_states, value);
131 }

◆ set_transitions() [1/2]

void dunedaq::confmodel::FSMconfiguration::set_transitions ( const std::vector< const dunedaq::confmodel::FSMtransition * > & value)

Set "transitions" relationship value.

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

Definition at line 125 of file FSMconfiguration.cpp.

126 {
127 _set_objects(s_transitions, value);
128 }

◆ set_transitions() [2/2]

void dunedaq::confmodel::FSMconfiguration::set_transitions ( const std::vector< const dunedaq::confmodel::FSMtransition * > & value)

Set "transitions" relationship value.

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

Friends And Related Symbol Documentation

◆ conffwk::Configuration

conffwk::Configuration
friend

Definition at line 34 of file FSMconfiguration.hpp.

◆ conffwk::DalFactory

conffwk::DalFactory
friend

Definition at line 36 of file FSMconfiguration.hpp.

◆ conffwk::DalObject

conffwk::DalObject
friend

Definition at line 35 of file FSMconfiguration.hpp.

◆ conffwk::DalRegistry

conffwk::DalRegistry
friend

Definition at line 37 of file FSMconfiguration.hpp.

Member Data Documentation

◆ m_actions

std::vector< const dunedaq::confmodel::FSMaction * > dunedaq::confmodel::FSMconfiguration::m_actions
private

Definition at line 89 of file FSMconfiguration.hpp.

◆ m_command_sequences

std::vector< const dunedaq::confmodel::FSMsequence * > dunedaq::confmodel::FSMconfiguration::m_command_sequences
private

Definition at line 86 of file FSMconfiguration.hpp.

◆ m_initial_state

std::string dunedaq::confmodel::FSMconfiguration::m_initial_state
private

Definition at line 84 of file FSMconfiguration.hpp.

◆ m_post_transitions

std::vector< const dunedaq::confmodel::FSMxTransition * > dunedaq::confmodel::FSMconfiguration::m_post_transitions
private

Definition at line 88 of file FSMconfiguration.hpp.

◆ m_pre_transitions

std::vector< const dunedaq::confmodel::FSMxTransition * > dunedaq::confmodel::FSMconfiguration::m_pre_transitions
private

Definition at line 87 of file FSMconfiguration.hpp.

◆ m_states

std::vector< std::string > dunedaq::confmodel::FSMconfiguration::m_states
private

Definition at line 83 of file FSMconfiguration.hpp.

◆ m_transitions

std::vector< const dunedaq::confmodel::FSMtransition * > dunedaq::confmodel::FSMconfiguration::m_transitions
private

Definition at line 85 of file FSMconfiguration.hpp.

◆ s_actions

static const std::string dunedaq::confmodel::FSMconfiguration::s_actions = "actions"
inlinestatic

Definition at line 171 of file FSMconfiguration.hpp.

◆ s_class_name

static const std::string & dunedaq::confmodel::FSMconfiguration::s_class_name
static

The name of the configuration class.

Definition at line 49 of file FSMconfiguration.hpp.

◆ s_command_sequences

static const std::string dunedaq::confmodel::FSMconfiguration::s_command_sequences = "command_sequences"
inlinestatic

Definition at line 168 of file FSMconfiguration.hpp.

◆ s_initial_state

static const std::string dunedaq::confmodel::FSMconfiguration::s_initial_state = "initial_state"
inlinestatic

Definition at line 97 of file FSMconfiguration.hpp.

◆ s_post_transitions

static const std::string dunedaq::confmodel::FSMconfiguration::s_post_transitions = "post_transitions"
inlinestatic

Definition at line 170 of file FSMconfiguration.hpp.

◆ s_pre_transitions

static const std::string dunedaq::confmodel::FSMconfiguration::s_pre_transitions = "pre_transitions"
inlinestatic

Definition at line 169 of file FSMconfiguration.hpp.

◆ s_states

static const std::string dunedaq::confmodel::FSMconfiguration::s_states = "states"
inlinestatic

Definition at line 96 of file FSMconfiguration.hpp.

◆ s_transitions

static const std::string dunedaq::confmodel::FSMconfiguration::s_transitions = "transitions"
inlinestatic

Definition at line 167 of file FSMconfiguration.hpp.

The documentation for this class was generated from the following files:
Generated on Sat Jun 28 2025 for DUNE-DAQ by doxygen 1.12.0