Electromagnetic field manager. More...

#include <bayeux/emfield/electromagnetic_field_manager.h>

Inheritance diagram for emfield::electromagnetic_field_manager:

Public Types
enum	init_flags { INIT_DEBUG = datatools::bit_mask::bit00, INIT_NO_PRELOAD = datatools::bit_mask::bit01 }
	Initialization flag. More...

typedef base_electromagnetic_field::factory_register_type	emfield_factory_type
	Type alias for the factory. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Public Member Functions
void	set_logging_priority (datatools::logger::priority priority_)
	Set the logging priority. More...

datatools::logger::priority	get_logging_priority () const
	Return the logging priority. More...

bool	is_initialized () const
	Check initialization status. More...

void	set_factory_preload (bool)
	Set the factory preload flag. More...

void	set_factory_verbose (bool)
	Set the factory verbose flag. More...

bool	has_service_manager () const
	Check if a service manager is referenced. More...

void	set_service_manager (datatools::service_manager &)
	Set the reference to a service manager. More...

void	reset_service_manager ()
	Reset the reference to a service manager. More...

bool	has_geometry_manager () const
	Check if a geometry manager is referenced. More...

void	set_geometry_manager (const geomtools::manager &)
	Set the reference to a geometry manager. More...

const geomtools::manager &	get_geometry_manager () const
	Return a const reference to a geometry manager. More...

bool	has_geom_map () const
	Check if a geometry/EM-fields association map is defined. More...

	electromagnetic_field_manager (uint32_t flags_=0)
	Default constructor. More...

virtual	~electromagnetic_field_manager ()
	Destructor. More...

void	initialize (const datatools::properties &setup_)
	Initialize the manager. More...

void	reset ()
	Reset the manager. More...

void	load (const std::string &field_definitions_filename_)
	Load the definitions of some EM fields from a file, given its name. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

const base_electromagnetic_field::field_dict_type &	get_fields () const
	Return the dictionary of created fields. More...

bool	has_field (const std::string &field_name_) const
	CHeck if a field exists, given its name. More...

base_electromagnetic_field &	grab_field (const std::string &field_name_)
	Return a mutable reference to an existing field. More...

const base_electromagnetic_field &	get_field (const std::string &field_name_) const
	Return a const reference to an existing field. More...

const geom_map &	get_geom_map () const
	Return the dictionary of geometry/EM-field associations. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Protected Member Functions
void	_set_defaults ()
	Set default attributes' values. More...

void	_set_initialized (bool initialized_)
	Set the initialization flag. More...

Additional Inherited Members
Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Detailed Description

Electromagnetic field manager.

Member Typedef Documentation

◆ emfield_factory_type

typedef base_electromagnetic_field::factory_register_type emfield::electromagnetic_field_manager::emfield_factory_type

Type alias for the factory.

Member Enumeration Documentation

◆ init_flags

enum emfield::electromagnetic_field_manager::init_flags

Initialization flag.

Enumerator
INIT_DEBUG
INIT_NO_PRELOAD

Constructor & Destructor Documentation

◆ electromagnetic_field_manager()

emfield::electromagnetic_field_manager::electromagnetic_field_manager ( uint32_t flags_ = 0 )

Default constructor.

◆ ~electromagnetic_field_manager()

virtual emfield::electromagnetic_field_manager::~electromagnetic_field_manager ( )

virtual

Destructor.

Member Function Documentation

◆ _set_defaults()

void emfield::electromagnetic_field_manager::_set_defaults ( )

protected

Set default attributes' values.

◆ _set_initialized()

void emfield::electromagnetic_field_manager::_set_initialized ( bool initialized_ )

protected

Set the initialization flag.

◆ get_field()

const base_electromagnetic_field& emfield::electromagnetic_field_manager::get_field ( const std::string & field_name_ ) const

Return a const reference to an existing field.

◆ get_fields()

const base_electromagnetic_field::field_dict_type& emfield::electromagnetic_field_manager::get_fields ( ) const

Return the dictionary of created fields.

◆ get_geom_map()

const geom_map& emfield::electromagnetic_field_manager::get_geom_map ( ) const

Return the dictionary of geometry/EM-field associations.

◆ get_geometry_manager()

const geomtools::manager& emfield::electromagnetic_field_manager::get_geometry_manager ( ) const

Return a const reference to a geometry manager.

◆ get_logging_priority()

datatools::logger::priority emfield::electromagnetic_field_manager::get_logging_priority ( ) const

Return the logging priority.

◆ grab_field()

base_electromagnetic_field& emfield::electromagnetic_field_manager::grab_field ( const std::string & field_name_ )

Return a mutable reference to an existing field.

◆ has_field()

bool emfield::electromagnetic_field_manager::has_field ( const std::string & field_name_ ) const

CHeck if a field exists, given its name.

◆ has_geom_map()

bool emfield::electromagnetic_field_manager::has_geom_map ( ) const

Check if a geometry/EM-fields association map is defined.

◆ has_geometry_manager()

bool emfield::electromagnetic_field_manager::has_geometry_manager ( ) const

Check if a geometry manager is referenced.

◆ has_service_manager()

bool emfield::electromagnetic_field_manager::has_service_manager ( ) const

Check if a service manager is referenced.

◆ initialize()

void emfield::electromagnetic_field_manager::initialize ( const datatools::properties & setup_ )

Initialize the manager.

◆ is_initialized()

bool emfield::electromagnetic_field_manager::is_initialized ( ) const

Check initialization status.

◆ load()

void emfield::electromagnetic_field_manager::load ( const std::string & field_definitions_filename_ )

Load the definitions of some EM fields from a file, given its name.

◆ reset()

void emfield::electromagnetic_field_manager::reset ( )

Reset the manager.

◆ reset_service_manager()

void emfield::electromagnetic_field_manager::reset_service_manager ( )

Reset the reference to a service manager.

◆ set_factory_preload()

void emfield::electromagnetic_field_manager::set_factory_preload ( bool )

Set the factory preload flag.

◆ set_factory_verbose()

void emfield::electromagnetic_field_manager::set_factory_verbose ( bool )

Set the factory verbose flag.

◆ set_geometry_manager()

void emfield::electromagnetic_field_manager::set_geometry_manager ( const geomtools::manager & )

Set the reference to a geometry manager.

◆ set_logging_priority()

void emfield::electromagnetic_field_manager::set_logging_priority ( datatools::logger::priority priority_ )

Set the logging priority.

◆ set_service_manager()

void emfield::electromagnetic_field_manager::set_service_manager ( datatools::service_manager & )

Set the reference to a service manager.

◆ tree_dump()

virtual void emfield::electromagnetic_field_manager::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const