Opens one collector file and discovers all collector groups and parameters. More...

#include <reader.h>

Public Member Functions
RL_API	ReaderSource (const std::string &filename, const bool warn_build=true)

RL_API size_t	points () const

RL_API const std::vector< Reader > &	readers () const

RL_API bool	has_parameters () const

RL_API const std::vector< std::string > &	parameter_names () const

RL_API const std::vector< ParameterDatasetView > &	parameter_views () const

RL_API const Reader &	reader (const std::string &collector_name) const

RL_API std::vector< uint8_t >	parameter_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_double (const std::string &name) const

RL_API double	parameter_double_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_float (const std::string &name) const

RL_API float	parameter_float_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_char (const std::string &name) const

RL_API char	parameter_char_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_int (const std::string &name) const

RL_API int	parameter_int_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_int32 (const std::string &name) const

RL_API int32_t	parameter_int32_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_int64 (const std::string &name) const

RL_API int64_t	parameter_int64_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_uint (const std::string &name) const

RL_API unsigned int	parameter_uint_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_uint32 (const std::string &name) const

RL_API uint32_t	parameter_uint32_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_uint64 (const std::string &name) const

RL_API uint64_t	parameter_uint64_value (const std::string &name, const size_t point) const

RL_API bool	parameter_is_string (const std::string &name) const

RL_API std::string	parameter_string_value (const std::string &name, const size_t point) const

Detailed Description

Opens one collector file and discovers all collector groups and parameters.

ReaderSource validates root metadata, constructs one Reader per collector group, and exposes point-aligned access to optional root parameters.

Definition at line 285 of file reader.h.

Constructor & Destructor Documentation

◆ ReaderSource()

RL_API ReaderSource::ReaderSource	(	const std::string &	filename,
		const bool	warn_build = `true`
	)

inlineexplicit

Parameters

warn_build whether to warn when another libreadout build wrote the file; off for a caller that has already validated it, which warns the same way

Definition at line 307 of file reader.h.

References warn_about_another_build().

Member Function Documentation

◆ has_parameters()

RL_API bool ReaderSource::has_parameters ( ) const

inline

Definition at line 389 of file reader.h.

◆ parameter_char_value()

RL_API char ReaderSource::parameter_char_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 481 of file reader.h.

◆ parameter_double_value()

RL_API double ReaderSource::parameter_double_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 428 of file reader.h.

◆ parameter_float_value()

RL_API float ReaderSource::parameter_float_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 454 of file reader.h.

◆ parameter_int32_value()

RL_API int32_t ReaderSource::parameter_int32_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 533 of file reader.h.

◆ parameter_int64_value()

RL_API int64_t ReaderSource::parameter_int64_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 559 of file reader.h.

◆ parameter_int_value()

RL_API int ReaderSource::parameter_int_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 507 of file reader.h.

◆ parameter_is_char()

RL_API bool ReaderSource::parameter_is_char ( const std::string & name ) const

inline

Definition at line 473 of file reader.h.

◆ parameter_is_double()

RL_API bool ReaderSource::parameter_is_double ( const std::string & name ) const

inline

Definition at line 419 of file reader.h.

◆ parameter_is_float()

RL_API bool ReaderSource::parameter_is_float ( const std::string & name ) const

inline

Definition at line 446 of file reader.h.

◆ parameter_is_int()

RL_API bool ReaderSource::parameter_is_int ( const std::string & name ) const

inline

Definition at line 499 of file reader.h.

◆ parameter_is_int32()

RL_API bool ReaderSource::parameter_is_int32 ( const std::string & name ) const

inline

Definition at line 525 of file reader.h.

◆ parameter_is_int64()

RL_API bool ReaderSource::parameter_is_int64 ( const std::string & name ) const

inline

Definition at line 551 of file reader.h.

◆ parameter_is_string()

RL_API bool ReaderSource::parameter_is_string ( const std::string & name ) const

inline

Definition at line 655 of file reader.h.

◆ parameter_is_uint()

RL_API bool ReaderSource::parameter_is_uint ( const std::string & name ) const

inline

Definition at line 577 of file reader.h.

◆ parameter_is_uint32()

RL_API bool ReaderSource::parameter_is_uint32 ( const std::string & name ) const

inline

Definition at line 603 of file reader.h.

◆ parameter_is_uint64()

RL_API bool ReaderSource::parameter_is_uint64 ( const std::string & name ) const

inline

Definition at line 629 of file reader.h.

◆ parameter_names()

RL_API const std::vector< std::string > & ReaderSource::parameter_names ( ) const

inline

Definition at line 390 of file reader.h.

◆ parameter_string_value()

RL_API std::string ReaderSource::parameter_string_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 663 of file reader.h.

◆ parameter_uint32_value()

RL_API uint32_t ReaderSource::parameter_uint32_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 611 of file reader.h.

◆ parameter_uint64_value()

RL_API uint64_t ReaderSource::parameter_uint64_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 637 of file reader.h.

◆ parameter_uint_value()

RL_API unsigned int ReaderSource::parameter_uint_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 585 of file reader.h.

◆ parameter_value()

RL_API std::vector< uint8_t > ReaderSource::parameter_value	(	const std::string &	name,
		const size_t	point
	)		const

inline

Definition at line 402 of file reader.h.

◆ parameter_views()

RL_API const std::vector< ParameterDatasetView > & ReaderSource::parameter_views ( ) const

inline

Definition at line 391 of file reader.h.

◆ points()

RL_API size_t ReaderSource::points ( ) const

inline

Definition at line 387 of file reader.h.

◆ reader()

RL_API const Reader & ReaderSource::reader ( const std::string & collector_name ) const

inline

Definition at line 393 of file reader.h.

◆ readers()

RL_API const std::vector< Reader > & ReaderSource::readers ( ) const

inline

Definition at line 388 of file reader.h.

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

readout_core/include/reader.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ReaderSource()

Member Function Documentation

◆ has_parameters()

◆ parameter_char_value()

◆ parameter_double_value()

◆ parameter_float_value()

◆ parameter_int32_value()

◆ parameter_int64_value()

◆ parameter_int_value()

◆ parameter_is_char()

◆ parameter_is_double()

◆ parameter_is_float()

◆ parameter_is_int()

◆ parameter_is_int32()

◆ parameter_is_int64()

◆ parameter_is_string()

◆ parameter_is_uint()

◆ parameter_is_uint32()

◆ parameter_is_uint64()

◆ parameter_names()

◆ parameter_string_value()

◆ parameter_uint32_value()

◆ parameter_uint64_value()

◆ parameter_uint_value()

◆ parameter_value()

◆ parameter_views()

◆ points()

◆ reader()

◆ readers()