Public Member Functions | Public Attributes | List of all members
Gaudi::Utils::Histos::Table Class Reference

Simple class for the customizeble printout of the histogram tables. More...

#include <GaudiUtils/HistoTableFormat.h>

Collaboration diagram for Gaudi::Utils::Histos::Table:
Collaboration graph
[legend]

Public Member Functions

 Table (const int ID=0)
 constructor from enum More...
 
 Table (const std::string &format, const std::string &header="", const std::string &footer="")
 Constructor from the format, header and footer. More...
 
template<class HISTO , class STREAM , class TERMINATOR >
STREAM & printList (HISTO first, HISTO last, STREAM &stream, TERMINATOR term) const
 print the simple sequence of histograms as table More...
 
template<class HISTO , class STREAM , class TERMINATOR >
STREAM & printMap (HISTO first, HISTO last, const std::string &fmt, const std::string &hval, STREAM &stream, TERMINATOR term) const
 print as table the content of the accociative map (key->histogram) with the key, convertible to std::string More...
 
const std::string & header () const
 the table header More...
 
const std::string & footer () const
 the table footer More...
 
const std::string & format () const
 the format More...
 
void setHeader (const std::string &v)
 set new header More...
 
void setFooter (const std::string &v)
 set new footer More...
 
void setFormat (const std::string &v)
 set new format More...
 
std::string toString (const AIDA::IHistogram1D *histo) const
 make the string representation according to the default format More...
 
std::string toString (const AIDA::IHistogram1D *histo, const std::string &ID, const std::string &fmt) const
 format a full row in table, including ID, label, path or any other "extra" identifier More...
 
 Table (const int ID=0)
 constructor from enum More...
 
 Table (const std::string &format, const std::string &header="", const std::string &footer="")
 Constructor from the format, header and footer. More...
 
template<class HISTO , class STREAM , class TERMINATOR >
STREAM & printList (HISTO first, HISTO last, STREAM &stream, TERMINATOR term) const
 print the simple sequence of histograms as table More...
 
template<class HISTO , class STREAM , class TERMINATOR >
STREAM & printMap (HISTO first, HISTO last, const std::string &fmt, const std::string &hval, STREAM &stream, TERMINATOR term) const
 print as table the content of the accociative map (key->histogram) with the key, convertible to std::string More...
 
const std::string & header () const
 the table header More...
 
const std::string & footer () const
 the table footer More...
 
const std::string & format () const
 the format More...
 
void setHeader (const std::string &v)
 set new header More...
 
void setFooter (const std::string &v)
 set new footer More...
 
void setFormat (const std::string &v)
 set new format More...
 
std::string toString (const AIDA::IHistogram1D *histo) const
 make the string representation according to the default format More...
 
std::string toString (const AIDA::IHistogram1D *histo, const std::string &ID, const std::string &fmt) const
 format a full row in table, including ID, label, path or any other "extra" identifier More...
 

Public Attributes

std::string m_header
 the table header More...
 
std::string m_footer
 the table footer More...
 
std::string m_format
 the defautl format More...
 

Detailed Description

Simple class for the customizeble printout of the histogram tables.

Author
Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u
Date
2007-08-07

Definition at line 411 of file HistoTableFormat.h.

Constructor & Destructor Documentation

Gaudi::Utils::Histos::Table::Table ( const int  ID = 0)

constructor from enum

Definition at line 290 of file HistoTableFormat.cpp.

291  : m_header ( Gaudi::Utils::Histos::Formats::header ( ID ) )
292  , m_footer ()
293  , m_format ( Gaudi::Utils::Histos::Formats::format ( ID ) )
294 {}
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
Gaudi::Utils::Histos::Formats::format
GAUDI_API std::string format(const int ID=Default)
get the format by enum
Definition: HistoTableFormat.cpp:139
Gaudi::Utils::Histos::Formats::header
GAUDI_API std::string header(const int ID=Default)
get the recommended header by enum
Definition: HistoTableFormat.cpp:162
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
Gaudi::Utils::Histos::Table::Table ( const std::string &  format,
const std::string &  header = "",
const std::string &  footer = "" 
)

Constructor from the format, header and footer.

Definition at line 297 of file HistoTableFormat.cpp.

300  : m_header ( header )
301  , m_footer ( footer )
302  , m_format ( format )
303 {}
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:473
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
Gaudi::Utils::Histos::Table::footer
const std::string & footer() const
the table footer
Definition: HistoTableFormat.h:476
Gaudi::Utils::Histos::Table::Table ( const int  ID = 0)

constructor from enum

Gaudi::Utils::Histos::Table::Table ( const std::string &  format,
const std::string &  header = "",
const std::string &  footer = "" 
)

Constructor from the format, header and footer.

Member Function Documentation

const std::string& Gaudi::Utils::Histos::Table::footer ( ) const
inline

the table footer

Definition at line 476 of file HistoTableFormat.h.

476 { return m_footer ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
const std::string& Gaudi::Utils::Histos::Table::footer ( ) const
inline

the table footer

Definition at line 476 of file HistoTableFormat.h.

476 { return m_footer ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
const std::string& Gaudi::Utils::Histos::Table::format ( ) const
inline

the format

Definition at line 479 of file HistoTableFormat.h.

479 { return m_format ; }
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
const std::string& Gaudi::Utils::Histos::Table::format ( ) const
inline

the format

Definition at line 479 of file HistoTableFormat.h.

479 { return m_format ; }
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
const std::string& Gaudi::Utils::Histos::Table::header ( ) const
inline

the table header

Definition at line 473 of file HistoTableFormat.h.

473 { return m_header ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
const std::string& Gaudi::Utils::Histos::Table::header ( ) const
inline

the table header

Definition at line 473 of file HistoTableFormat.h.

473 { return m_header ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
template<class HISTO , class STREAM , class TERMINATOR >
STREAM& Gaudi::Utils::Histos::Table::printList ( HISTO  first,
HISTO  last,
STREAM &  stream,
TERMINATOR  term 
) const
inline

print the simple sequence of histograms as table

Parameters
firstbegin-iterator for the sequence
lastend-iterator for the sequence
streamthe stream to be used for printout
termthe terminmator for the stream

Definition at line 431 of file HistoTableFormat.h.

435  {
436  if ( !header().empty() ) { stream << header () << term ; }
437  Gaudi::Utils::Histos::printList ( first , last , format() , stream , term ) ;
438  if ( !footer().empty() ) { stream << footer () << term ; }
439  return stream ;
440  }
Gaudi::Utils::Histos::printList
STREAM & printList(HISTO first, HISTO last, const std::string &fmt, STREAM &stream, TERMINATOR term)
print the simple sequence (list-like) of histograms as table
Definition: HistoTableFormat.h:233
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:473
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
Gaudi::Utils::Histos::Table::footer
const std::string & footer() const
the table footer
Definition: HistoTableFormat.h:476
template<class HISTO , class STREAM , class TERMINATOR >
STREAM& Gaudi::Utils::Histos::Table::printList ( HISTO  first,
HISTO  last,
STREAM &  stream,
TERMINATOR  term 
) const
inline

print the simple sequence of histograms as table

Parameters
firstbegin-iterator for the sequence
lastend-iterator for the sequence
streamthe stream to be used for printout
termthe terminmator for the stream

Definition at line 431 of file HistoTableFormat.h.

435  {
436  if ( !header().empty() ) { stream << header () << term ; }
437  Gaudi::Utils::Histos::printList ( first , last , format() , stream , term ) ;
438  if ( !footer().empty() ) { stream << footer () << term ; }
439  return stream ;
440  }
Gaudi::Utils::Histos::printList
STREAM & printList(HISTO first, HISTO last, const std::string &fmt, STREAM &stream, TERMINATOR term)
print the simple sequence (list-like) of histograms as table
Definition: HistoTableFormat.h:233
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:473
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
Gaudi::Utils::Histos::Table::footer
const std::string & footer() const
the table footer
Definition: HistoTableFormat.h:476
template<class HISTO , class STREAM , class TERMINATOR >
STREAM& Gaudi::Utils::Histos::Table::printMap ( HISTO  first,
HISTO  last,
const std::string &  fmt,
const std::string &  hval,
STREAM &  stream,
TERMINATOR  term 
) const
inline

print as table the content of the accociative map (key->histogram) with the key, convertible to std::string

The default format is used for histogram prinout

Parameters
first'begin'-iterator for the mapping sequence
last'end'-iterator for the mapping sequence
fmt'short' format for the table printout
hvalthe name of the "key"-column
streamthe stream for printout
termstream terminator

Definition at line 457 of file HistoTableFormat.h.

463  {
464  if ( !hval.empty() || !header().empty() )
465  { stream << Gaudi::Utils::Histos::format ( hval , header() , fmt ) << term ; }
466  return Gaudi::Utils::Histos::printMap
467  ( first , last , fmt , format() , stream , term ) ;
468  }
Gaudi::Utils::Histos::printMap
STREAM & printMap(HISTO begin, HISTO end, const std::string &fmt1, const std::string &fmt2, STREAM &stream, TERMINATOR term)
Print the "associative sequence" (e.g.
Definition: HistoTableFormat.h:324
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:473
Gaudi::Utils::Histos::format
GAUDI_API std::string format(const AIDA::IHistogram1D *histo, const std::string &fmt)
Make the string representation of the historgam according to the specified format.
Definition: HistoTableFormat.cpp:203
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
template<class HISTO , class STREAM , class TERMINATOR >
STREAM& Gaudi::Utils::Histos::Table::printMap ( HISTO  first,
HISTO  last,
const std::string &  fmt,
const std::string &  hval,
STREAM &  stream,
TERMINATOR  term 
) const
inline

print as table the content of the accociative map (key->histogram) with the key, convertible to std::string

The default format is used for histogram prinout

Parameters
first'begin'-iterator for the mapping sequence
last'end'-iterator for the mapping sequence
fmt'short' format for the table printout
hvalthe name of the "key"-column
streamthe stream for printout
termstream terminator

Definition at line 457 of file HistoTableFormat.h.

463  {
464  if ( !hval.empty() || !header().empty() )
465  { stream << Gaudi::Utils::Histos::format ( hval , header() , fmt ) << term ; }
466  return Gaudi::Utils::Histos::printMap
467  ( first , last , fmt , format() , stream , term ) ;
468  }
Gaudi::Utils::Histos::printMap
STREAM & printMap(HISTO begin, HISTO end, const std::string &fmt1, const std::string &fmt2, STREAM &stream, TERMINATOR term)
Print the "associative sequence" (e.g.
Definition: HistoTableFormat.h:324
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:473
Gaudi::Utils::Histos::format
GAUDI_API std::string format(const AIDA::IHistogram1D *histo, const std::string &fmt)
Make the string representation of the historgam according to the specified format.
Definition: HistoTableFormat.cpp:203
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
void Gaudi::Utils::Histos::Table::setFooter ( const std::string &  v)
inline

set new footer

Definition at line 487 of file HistoTableFormat.h.

487 { m_footer = v ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
void Gaudi::Utils::Histos::Table::setFooter ( const std::string &  v)
inline

set new footer

Definition at line 487 of file HistoTableFormat.h.

487 { m_footer = v ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:531
void Gaudi::Utils::Histos::Table::setFormat ( const std::string &  v)
inline

set new format

Definition at line 490 of file HistoTableFormat.h.

490 { m_format = v ; }
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
void Gaudi::Utils::Histos::Table::setFormat ( const std::string &  v)
inline

set new format

Definition at line 490 of file HistoTableFormat.h.

490 { m_format = v ; }
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:533
void Gaudi::Utils::Histos::Table::setHeader ( const std::string &  v)
inline

set new header

Definition at line 484 of file HistoTableFormat.h.

484 { m_header = v ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
void Gaudi::Utils::Histos::Table::setHeader ( const std::string &  v)
inline

set new header

Definition at line 484 of file HistoTableFormat.h.

484 { m_header = v ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:529
std::string Gaudi::Utils::Histos::Table::toString ( const AIDA::IHistogram1D *  histo) const

make the string representation according to the default format

std::string Gaudi::Utils::Histos::Table::toString ( const AIDA::IHistogram1D *  histo) const

make the string representation according to the default format

Definition at line 308 of file HistoTableFormat.cpp.

309 { return Gaudi::Utils::Histos::format ( histo , format() ) ; }
Gaudi::Utils::Histos::format
GAUDI_API std::string format(const AIDA::IHistogram1D *histo, const std::string &fmt)
Make the string representation of the historgam according to the specified format.
Definition: HistoTableFormat.cpp:203
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
std::string Gaudi::Utils::Histos::Table::toString ( const AIDA::IHistogram1D *  histo,
const std::string &  ID,
const std::string &  fmt 
) const

format a full row in table, including ID, label, path or any other "extra" identifier

using namespace Gaudi::Utils::Histos ;
const Table& table = ... ;
const AIDA::IHistogram1D* histo = ... ;
// define short format
const std::string fmt1 = " |%1$-30.30s %|33t| %2" ;
info () << table.toString ( "My Histo" , histo , fmt ) ;
Parameters
histopointer to the histogram
IDhistorgam ID, title, label or other extra infomration
fmt"short" format used for the table
Returns
formatted row

Definition at line 316 of file HistoTableFormat.cpp.

319 { return Gaudi::Utils::Histos::format ( histo , ID , fmt , format() ) ; }
Gaudi::Utils::Histos::format
GAUDI_API std::string format(const AIDA::IHistogram1D *histo, const std::string &fmt)
Make the string representation of the historgam according to the specified format.
Definition: HistoTableFormat.cpp:203
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:479
std::string Gaudi::Utils::Histos::Table::toString ( const AIDA::IHistogram1D *  histo,
const std::string &  ID,
const std::string &  fmt 
) const

format a full row in table, including ID, label, path or any other "extra" identifier

using namespace Gaudi::Utils::Histos ;
const Table& table = ... ;
const AIDA::IHistogram1D* histo = ... ;
// define short format
const std::string fmt1 = " |%1$-30.30s %|33t| %2" ;
info () << table.toString ( "My Histo" , histo , fmt ) ;
Parameters
histopointer to the histogram
IDhistorgam ID, title, label or other extra infomration
fmt"short" format used for the table
Returns
formatted row

Member Data Documentation

std::string Gaudi::Utils::Histos::Table::m_footer

the table footer

Definition at line 531 of file HistoTableFormat.h.

std::string Gaudi::Utils::Histos::Table::m_format

the defautl format

Definition at line 533 of file HistoTableFormat.h.

std::string Gaudi::Utils::Histos::Table::m_header

the table header

Definition at line 529 of file HistoTableFormat.h.

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