datatools::i_tree_dumpable Class Reference

An interface with utilities for printable objects. More...

#include <bayeux/datatools/i_tree_dump.h>

Inheritance diagram for datatools::i_tree_dumpable:

Classes
struct	base_print_options
	Default print options POD. More...
class	inherit_skip_tag
	Output stream manipulator. More...
class	inherit_tag
	Output stream manipulator. More...
struct	tags
	Default tags for tree-formated print. More...

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

Public Member Functions
	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...
virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Main old 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

Static Public Member Functions
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

An interface with utilities for printable objects.

Member Enumeration Documentation

ostream_type

enum datatools::i_tree_dumpable::ostream_type

Enumeration for standard output streams.

Enumerator
OSTREAM_COUT
OSTREAM_CERR
OSTREAM_CLOG

Constructor & Destructor Documentation

i_tree_dumpable()

datatools::i_tree_dumpable::i_tree_dumpable

(

)

Constructor.

~i_tree_dumpable()

virtual datatools::i_tree_dumpable::~i_tree_dumpable ( )

virtual

Destructor.

Member Function Documentation

empty_options()

static const boost::property_tree::ptree& datatools::i_tree_dumpable::empty_options ( )

static

last_skip_tag()

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

static

last_tag()

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

static

make_base_print_options()

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

static

print_tree()

virtual void datatools::i_tree_dumpable::print_tree ( std::ostream &  out_ = std::clog, const boost::property_tree::ptree &  options_ = empty_options()  ) const

virtual

Main new interface method for printing.

Reimplemented in datatools::properties, mctools::base_step_hit, datatools::multi_properties, datatools::ui::basic_shell, mctools::simulated_data, geomtools::id_mgr, geomtools::base_hit, geomtools::id_mgr::category_info, datatools::enriched_base, datatools::multi_properties::entry, and datatools::base_service.

print_tree_json() [1/2]

void datatools::i_tree_dumpable::print_tree_json	(	std::ostream &	out_ = std::clog,
		const std::string &	json_options_ = ""
	)		const

Printing with jsonized options.

print_tree_json() [2/2]

void datatools::i_tree_dumpable::print_tree_json	(	std::ostream &	out_ = std::clog,
		const char *	json_options_ = nullptr
	)		const

Printing with jsonized options.

skip_tag()

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

static

smart_print_id()

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

tag()

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

static

tree_dump()

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

virtual

Main old interface method for printing.

Reimplemented in datatools::properties, datatools::units::registry, datatools::configuration::parameter_model, datatools::units::unit_dimension, materials::isotope, datatools::units::unit, geomtools::tessellated_solid, geomtools::placement, geomtools::manager, genbb::primary_particle, datatools::ui::ihs, datatools::io_factory, mctools::base_step_hit, datatools::multi_properties, geomtools::polycone, datatools::kernel, cuts::i_cut, datatools::things, mctools::simulated_data, materials::material, genbb::beta_decay, datatools::urn_db_service, geomtools::tube, datatools::configuration::ui::variant_registry_tree_model, geomtools::polyhedra, geomtools::i_shape_3d, datatools::service_manager, geomtools::sphere, mctools::biasing::primary_event_bias, mctools::signal::base_signal, genbb::pdg::particle_registry, materials::element, genbb::nuclear_level, datatools::library_info, geomtools::extruded_box, mygsl::histogram, datatools::urn_info, geomtools::face_identifier, geomtools::blur_spot, geomtools::stackable_data, datatools::ui::ihs::node, geomtools::quadric, genbb::manager, geomtools::torus, datatools::ui::const_target_command_interface< Type >, geomtools::manager::plugin_entry, datatools::introspection::argument, mctools::digitization::sampled_signal, geomtools::i_object_3d, genvtx::manager, datatools::configuration::variant_repository, geomtools::box, genvtx::vertex_validation, geomtools::model_with_internal_mesh_data, datatools::configuration::variant_dependency_model, geomtools::angular_range::iterator, mygsl::parameter_store, datatools::configuration::parameter_model::base_enum_metadata, genvtx::i_vertex_generator, datatools::introspection::data_description, mygsl::histogram_pool, genbb::pdg::particle, genbb::primary_event, geomtools::cylinder, geomtools::i_composite_shape_3d, geomtools::elliptical_cylinder, geomtools::right_circular_conical_frustrum, datatools::ui::const_target_command< Type >, datatools::ui::const_target_command< basic_shell >, genbb::nuclear_transition, mygsl::i_unary_function, datatools::event_id, dpp::base_module, emfield::base_electromagnetic_field, mctools::signal::signal_shape_builder, geomtools::ellipsoid, datatools::introspection::unit_info, mctools::step_hit_processor_factory, datatools::configuration::slot_logic, datatools::configuration::variant_dependency, geomtools::base_hit, materials::isotope::record_type, datatools::configuration::variant_registry, geomtools::right_polygonal_frustrum, geomtools::helix_3d, datatools::enriched_base, datatools::multi_properties::entry, datatools::ui::base_command, cuts::cut_entry_type, geomtools::ellipse, datatools::factory_register< BaseType >, mctools::signal::triangle_gate_signal_shape, datatools::factory_register< mygsl::i_unary_function >, datatools::factory_register< genbb::i_genbb >, geomtools::face_info, datatools::service_entry, datatools::urn_to_path, geomtools::simple_polygon, emfield::multi_zone_field, geomtools::regular_grid_placement, geomtools::wall_solid, mctools::signal::triangle_signal_shape, mygsl::tabulated_function, datatools::introspection::method, genbb::alpha_decay, genbb::i_genbb, geomtools::disk, geomtools::regular_polygon, geomtools::logical_volume, mctools::simulated_data_reader, geomtools::ellipsoid_sector, materials::manager, mctools::biasing::point_of_interest, datatools::configuration::ui::tree_item, mctools::base_step_hit_processor, mctools::digitization::simple_linear_adc, geomtools::angular_range, geomtools::display_data, datatools::configuration::variant_model, mygsl::polynomial, cuts::cut_manager, geomtools::elliptical_sector, datatools::ui::base_command_interface, geomtools::spherical_sector, geomtools::elliptical_cylinder_sector, brio::detail::base_io, brio::writer, geomtools::quadrangle, geomtools::regular_3d_mesh_placement, geomtools::right_circular_conical_nappe, dpp::module_entry_type, materials::isotope::id, geomtools::regular_linear_placement, mctools::signal::signal_data, datatools::urn_to_path_resolver_service, geomtools::bounding_data, geomtools::cylindrical_sector, geomtools::physical_volume, datatools::things::entry_type, genbb::nuclear_decay, brio::reader, datatools::base_service, emfield::electromagnetic_field_manager, genbb::nuclear_decay_manager, mygsl::triangle_function, geomtools::triangle, geomtools::circle, geomtools::polyline_3d, geomtools::model_factory, geomtools::regular_circular_placement, geomtools::toroid_nappe, genvtx::box_model_vg, dpp::if_module, dpp::output_module, mctools::signal::multi_signal_shape, datatools::ui::target_command_interface< Type >, emfield::oscillating_field, datatools::ui::target_command_interface< basic_shell >, dpp::module_manager, emfield::geom_map, datatools::configuration::base_dependency_logic, geomtools::composite_surface, mygsl::gate_function, dpp::input_module, genvtx::cylinder_vg, geomtools::cylindric_extrusion_boxed_model, genvtx::box_vg, geomtools::line_3d, mygsl::convolution_function, geomtools::shape_factory, mctools::calorimeter_step_hit_processor, datatools::configuration::variant_registry_manager, mygsl::i_unary_function_with_parameters, geomtools::rectangle, geomtools::simple_shaped_model, datatools::ui::target_command< Type >, mygsl::gaussian_function, datatools::ui::target_command< basic_shell >, geomtools::i_model, dpp::histogram_service, geomtools::i_placement, dpp::utils_cut, genvtx::tube_vg, mygsl::composite_function, genbb::wdecay0, dpp::context_service, cuts::cut_service, dpp::dump_module, mygsl::linear_combination_function, dpp::chain_module, genvtx::sphere_vg, mygsl::product_function, mygsl::functor_factory, datatools::configuration::parameter_physical, mctools::fluence_step_hit_processor, genvtx::polycone_vg, geomtools::i_composite_shape_3d::shape_type, emfield::polynomial_magnetic_field, genvtx::sphere_model_vg, datatools::urn_query_service, genbb::base_decay_driver, genvtx::i_from_model_vg, geomtools::geometry_service, emfield::linear_combination_field, datatools::configuration::variant_physical, genvtx::polycone_model_vg, emfield::placement_field, genvtx::tube_model_vg, genvtx::in_materials_vertex_validator, mygsl::rectangular_function, geomtools::multiple_placement, geomtools::plate_with_hole_model, genvtx::cylinder_model_vg, mygsl::min_max, geomtools::replicated_circular_model, mygsl::histogram_pool::histogram_entry_type, datatools::computing_time, cuts::i_binary_cut, geomtools::extruded_box_model, geomtools::spherical_extrusion_cylinder_model, emfield::uniform_magnetic_field, emfield::uniform_electric_field, geomtools::spherical_extrusion_box_model, mygsl::gompertz_function, mygsl::logistic_function, genvtx::not_in_daughters_vertex_validator, datatools::library_query_service, genvtx::combined_vg, mygsl::heaviside_function, and geomtools::simple_world_model.

tree_dump_id()

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

tree_print_id()

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

---

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

• bayeux/datatools/i_tree_dump.h