Abstract class for basic report elements (headers, tables, images etc.). More...

#include <BmnReportElement.h>

Inheritance diagram for BmnReportElement:

Collaboration diagram for BmnReportElement:

Public Member Functions
	BmnReportElement ()
	Constructor.
virtual	~BmnReportElement ()
	Destructor.
virtual string	TableBegin (const string &caption, const vector< string > &colNames) const =0
	Return string with table open tag.
virtual string	TableEnd () const =0
	Return string with table close tag.
virtual string	TableEmptyRow (int nofCols, const string &name) const =0
	Return string with table row which spans over all columns.
virtual string	TableRow (const vector< string > &row) const =0
	Return string with table row tags.
virtual string	Image (const string &title, const string &file) const =0
	Return string with image tags.
virtual string	DocumentBegin () const =0
	Return string with open tags for document.
virtual string	DocumentEnd () const =0
	Return string with close tags of the document.
virtual string	Title (int size, const string &title) const =0
	Return string with title.
	BmnReportElement ()
	Constructor.
virtual	~BmnReportElement ()
	Destructor.
virtual string	TableBegin (const string &caption, const vector< string > &colNames) const =0
	Return string with table open tag.
virtual string	TableEnd () const =0
	Return string with table close tag.
virtual string	TableEmptyRow (int nofCols, const string &name) const =0
	Return string with table row which spans over all columns.
virtual string	TableRow (const vector< string > &row) const =0
	Return string with table row tags.
virtual string	Image (const string &title, const string &file) const =0
	Return string with image tags.
virtual string	DocumentBegin () const =0
	Return string with open tags for document.
virtual string	DocumentEnd () const =0
	Return string with close tags of the document.
virtual string	Title (int size, const string &title) const =0
	Return string with title.
Public Member Functions inherited from TObject
	TObject ()
	TObject (const TObject &object)
virtual	~TObject ()
void	AbstractMethod (const char *method) const
virtual void	AppendPad (Option_t *option="")
virtual void	Browse (TBrowser *b)
ULong_t	CheckedHash ()
virtual const char *	ClassName () const
virtual void	Clear (Option_t *="")
virtual TObject *	Clone (const char *newname="") const
virtual Int_t	Compare (const TObject *obj) const
virtual void	Copy (TObject &object) const
virtual void	Delete (Option_t *option="")
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
virtual void	Draw (Option_t *option="")
virtual void	DrawClass () const
virtual TObject *	DrawClone (Option_t *option="") const
virtual void	Dump () const
virtual void	Error (const char method, const char msgfmt,...) const
virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
virtual void	Fatal (const char method, const char msgfmt,...) const
virtual TObject *	FindObject (const char *name) const
virtual TObject *	FindObject (const TObject *obj) const
virtual Option_t *	GetDrawOption () const
virtual const char *	GetIconName () const
virtual const char *	GetName () const
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
virtual Option_t *	GetOption () const
virtual const char *	GetTitle () const
virtual UInt_t	GetUniqueID () const
virtual Bool_t	HandleTimer (TTimer *timer)
virtual ULong_t	Hash () const
Bool_t	HasInconsistentHash () const
virtual void	Info (const char method, const char msgfmt,...) const
virtual Bool_t	InheritsFrom (const char *classname) const
virtual Bool_t	InheritsFrom (const TClass *cl) const
virtual void	Inspect () const
void	InvertBit (UInt_t f)
virtual TClass *	IsA () const
Bool_t	IsDestructed () const
virtual Bool_t	IsEqual (const TObject *obj) const
virtual Bool_t	IsFolder () const
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
virtual Bool_t	IsSortable () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
virtual void	ls (Option_t *option="") const
void	MayNotUse (const char *method) const
virtual Bool_t	Notify ()
void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
void	operator delete (void *ptr)
void	operator delete (void ptr, void vp)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, void vp)
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, void *vp)
TObject &	operator= (const TObject &rhs)
virtual void	Paint (Option_t *option="")
virtual void	Pop ()
virtual void	Print (Option_t *option="") const
virtual Int_t	Read (const char *name)
virtual void	RecursiveRemove (TObject *obj)
void	ResetBit (UInt_t f)
virtual void	SaveAs (const char filename="", Option_t option="") const
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
virtual void	SetDrawOption (Option_t *option="")
virtual void	SetUniqueID (UInt_t uid)
virtual void	Streamer (TBuffer &)
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char method, const char msgfmt,...) const
R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
virtual void	UseCurrentStyle ()
virtual void	Warning (const char method, const char msgfmt,...) const
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Additional Inherited Members
Public Types inherited from TObject
enum	EDeprecatedStatusBits
enum	EStatusBits
Static Public Member Functions inherited from TObject
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Longptr_t	GetDtorOnly ()
static Bool_t	GetObjectStat ()
static void	SetDtorOnly (void *obj)
static void	SetObjectStat (Bool_t stat)
Public Attributes inherited from TObject
	kIsOnHeap
	kNotDeleted
	kZombie
	kInconsistent
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
	kObjInCanvas
	kCanDelete
	kMustCleanup
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
void	MakeZombie ()
Static Protected Member Functions inherited from TObject
static void	SavePrimitiveConstructor (std::ostream &out, TClass cl, const char variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
static void	SavePrimitiveDraw (std::ostream &out, const char variable_name, Option_t option=nullptr)
static TString	SavePrimitiveVector (std::ostream &out, const char prefix, Int_t len, Double_t arr, Bool_t empty_line=kFALSE)
Protected Attributes inherited from TObject
	kOnlyPrepStep

Detailed Description

Each concrete implementation for report elements has to implement this interface (e.g. Latex, text, HTML). Report has to be written using functionality of this interface class in order to be able to automatically produce reports in different representations (e.g. Latex, text, HTML).

Author: Semen Lebedev s.leb.nosp@m.edev.nosp@m.@gsi..nosp@m.de

Date: 2011

Definition at line 33 of file BmnReportElement.h.

Constructor & Destructor Documentation

◆ BmnReportElement() [1/2]

BmnReportElement::BmnReportElement ( )

inline

Definition at line 39 of file BmnReportElement.h.

Referenced by Title().

Here is the caller graph for this function:

◆ ~BmnReportElement() [1/2]

virtual BmnReportElement::~BmnReportElement ( )

inlinevirtual

Definition at line 44 of file BmnReportElement.h.

◆ BmnReportElement() [2/2]

BmnReportElement::BmnReportElement ( )

inline

Definition at line 39 of file BmnReportElement.h.

◆ ~BmnReportElement() [2/2]

virtual BmnReportElement::~BmnReportElement ( )

inlinevirtual

Definition at line 44 of file BmnReportElement.h.

Member Function Documentation

◆ DocumentBegin() [1/2]

virtual string BmnReportElement::DocumentBegin ( ) const

pure virtual

Returns: string with open tags for document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

Referenced by BmnClusteringQaReport::Create(), BmnLambdaQaReport::Create(), BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), and BmnTrackingQaReport::Create().

Here is the caller graph for this function:

◆ DocumentBegin() [2/2]

virtual string BmnReportElement::DocumentBegin ( ) const

pure virtual

Returns: string with open tags for document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ DocumentEnd() [1/2]

virtual string BmnReportElement::DocumentEnd ( ) const

pure virtual

Returns: string with close tags of the document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

Referenced by BmnClusteringQaReport::Create(), BmnLambdaQaReport::Create(), BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), and BmnTrackingQaReport::Create().

Here is the caller graph for this function:

◆ DocumentEnd() [2/2]

virtual string BmnReportElement::DocumentEnd ( ) const

pure virtual

Returns: string with close tags of the document.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ Image() [1/2]

virtual string BmnReportElement::Image	(	const string &	title,
		const string &	file ) const

pure virtual

Parameters

[in]	title	Title of the image.
[in]	file	Name of the image file.

Returns: string with image tags.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

Referenced by BmnReport::PrintCanvases().

Here is the caller graph for this function:

◆ Image() [2/2]

virtual string BmnReportElement::Image	(	const string &	title,
		const string &	file ) const

pure virtual

Parameters

[in]	title	Title of the image.
[in]	file	Name of the image file.

Returns: string with image tags.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableBegin() [1/2]

virtual string BmnReportElement::TableBegin	(	const string &	caption,
		const vector< string > &	colNames ) const

pure virtual

Parameters

[in]	caption	Table caption.
[in]	colNames	Names of the columns in table.

Returns: String with table open tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableBegin() [2/2]

virtual string BmnReportElement::TableBegin	(	const string &	caption,
		const vector< string > &	colNames ) const

pure virtual

Parameters

[in]	caption	Table caption.
[in]	colNames	Names of the columns in table.

Returns: String with table open tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEmptyRow() [1/2]

virtual string BmnReportElement::TableEmptyRow	(	int	nofCols,
		const string &	name ) const

pure virtual

Parameters

[in]	nofCols	number of columns in table.
[in]	name	Name of the row.

Returns: string with table row which spans over all columns.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEmptyRow() [2/2]

virtual string BmnReportElement::TableEmptyRow	(	int	nofCols,
		const string &	name ) const

pure virtual

Parameters

[in]	nofCols	number of columns in table.
[in]	name	Name of the row.

Returns: string with table row which spans over all columns.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEnd() [1/2]

virtual string BmnReportElement::TableEnd ( ) const

pure virtual

Returns: String with table close tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableEnd() [2/2]

virtual string BmnReportElement::TableEnd ( ) const

pure virtual

Returns: String with table close tag.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableRow() [1/2]

virtual string BmnReportElement::TableRow ( const vector< string > & row ) const

pure virtual

Parameters

[in] row Array of strings with data for each cell in a row.

Returns: string with table row tags.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ TableRow() [2/2]

virtual string BmnReportElement::TableRow ( const vector< string > & row ) const

pure virtual

Parameters

[in] row Array of strings with data for each cell in a row.

Returns: string with table row tags.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

◆ Title() [1/2]

virtual string BmnReportElement::Title	(	int	size,
		const string &	title ) const

pure virtual

Parameters

[in]	size	Size of the title. [0-5]. 0 is the largest size.
[in]	title	Title string.

Returns: string with subtitle.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

References BmnReportElement().

Referenced by BmnClusteringQaReport::Create(), BmnLambdaQaReport::Create(), BmnPidQaReport::Create(), BmnProfQaReport::Create(), BmnSimulationReport::Create(), and BmnTrackingQaReport::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Title() [2/2]

virtual string BmnReportElement::Title	(	int	size,
		const string &	title ) const

pure virtual

Parameters

[in]	size	Size of the title. [0-5]. 0 is the largest size.
[in]	title	Title string.

Returns: string with subtitle.

Implemented in BmnHtmlReportElement, and BmnHtmlReportElement.

References BmnReportElement().

Here is the call graph for this function:

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

install/include/BmnReportElement.h
QA/report/BmnReportElement.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BmnReportElement() [1/2]

◆ ~BmnReportElement() [1/2]

◆ BmnReportElement() [2/2]

◆ ~BmnReportElement() [2/2]

Member Function Documentation

◆ DocumentBegin() [1/2]

◆ DocumentBegin() [2/2]

◆ DocumentEnd() [1/2]

◆ DocumentEnd() [2/2]

◆ Image() [1/2]

◆ Image() [2/2]

◆ TableBegin() [1/2]

◆ TableBegin() [2/2]

◆ TableEmptyRow() [1/2]

◆ TableEmptyRow() [2/2]

◆ TableEnd() [1/2]

◆ TableEnd() [2/2]

◆ TableRow() [1/2]

◆ TableRow() [2/2]

◆ Title() [1/2]

◆ Title() [2/2]