| The Gaudi Framework v28r2-patches (bc4ad17a)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

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:
[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 (std::string v)
| set new header More...
void | setFooter (std::string v)
| set new footer More...
void | setFormat (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 409 of file HistoTableFormat.h.

## Constructor & Destructor Documentation

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

constructor from enum

Definition at line 296 of file HistoTableFormat.cpp.

297 : m_header ( Gaudi::Utils::Histos::Formats::header ( ID ) )
298 , m_footer ()
299 , m_format ( Gaudi::Utils::Histos::Formats::format ( ID ) )
300 {}
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:527
Gaudi::Utils::Histos::Formats::header
GAUDI_API std::string header(const int ID=Default)
get the recommended header by enum
Definition: HistoTableFormat.cpp:168
Gaudi::Utils::Histos::Formats::format
GAUDI_API std::string format(const int ID=Default)
get the format by enum
Definition: HistoTableFormat.cpp:145
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:529
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:531

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 303 of file HistoTableFormat.cpp.

306 : m_header ( header )
307 , m_footer ( footer )
308 , m_format ( format )
309 {}
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:527
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:529
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:531

## Member Function Documentation

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

the table footer

Definition at line 474 of file HistoTableFormat.h.

474 { return m_footer ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:529

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

the format

Definition at line 477 of file HistoTableFormat.h.

477 { return m_format ; }
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:531

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

the table header

Definition at line 471 of file HistoTableFormat.h.

471 { return m_header ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:527
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

  first | begin-iterator for the sequence
  last | end-iterator for the sequence
  stream | the stream to be used for printout
  term | the terminmator for the stream

Definition at line 429 of file HistoTableFormat.h.

433 {
434 if ( !header().empty() ) { stream << header () << term ; }
435 Gaudi::Utils::Histos::printList ( first , last , format() , stream , term ) ;
436 if ( !footer().empty() ) { stream << footer () << term ; }
437 return stream ;
438 }
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:471
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:477
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:231
Gaudi::Utils::Histos::Table::footer
const std::string & footer() const
the table footer
Definition: HistoTableFormat.h:474
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
  hval | the name of the "key"-column
  stream | the stream for printout
  term | stream terminator

Definition at line 455 of file HistoTableFormat.h.

461 {
462 if ( !hval.empty() || !header().empty() )
463 { stream << Gaudi::Utils::Histos::format ( hval , header() , fmt ) << term ; }
464 return Gaudi::Utils::Histos::printMap
465 ( first , last , fmt , format() , stream , term ) ;
466 }
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:322
std::string::empty
T empty(T...args)
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:209
Gaudi::Utils::Histos::Table::header
const std::string & header() const
the table header
Definition: HistoTableFormat.h:471
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:477

void Gaudi::Utils::Histos::Table::setFooter | ( | std::string | v | ) |
| inline

set new footer

Definition at line 485 of file HistoTableFormat.h.

485 { m_footer = std::move(v) ; }
Gaudi::Utils::Histos::Table::m_footer
std::string m_footer
the table footer
Definition: HistoTableFormat.h:529
std::move
T move(T...args)

void Gaudi::Utils::Histos::Table::setFormat | ( | std::string | v | ) |
| inline

set new format

Definition at line 488 of file HistoTableFormat.h.

488 { m_format = std::move(v) ; }
std::move
T move(T...args)
Gaudi::Utils::Histos::Table::m_format
std::string m_format
the defautl format
Definition: HistoTableFormat.h:531

void Gaudi::Utils::Histos::Table::setHeader | ( | std::string | v | ) |
| inline

set new header

Definition at line 482 of file HistoTableFormat.h.

482 { m_header = std::move(v) ; }
Gaudi::Utils::Histos::Table::m_header
std::string m_header
the table header
Definition: HistoTableFormat.h:527
std::move
T move(T...args)

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

make the string representation according to the default format

Definition at line 314 of file HistoTableFormat.cpp.

315 { 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:209
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:477

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

  histo | pointer to the histogram
  ID | historgam ID, title, label or other extra infomration
  fmt | "short" format used for the table

Returns
  formatted row

Definition at line 322 of file HistoTableFormat.cpp.

325 { 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:209
Gaudi::Utils::Histos::Table::format
const std::string & format() const
the format
Definition: HistoTableFormat.h:477

## Member Data Documentation

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

the table footer

Definition at line 529 of file HistoTableFormat.h.

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

the defautl format

Definition at line 531 of file HistoTableFormat.h.

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

the table header

Definition at line 527 of file HistoTableFormat.h.

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

- GaudiUtils/GaudiUtils/HistoTableFormat.h
- GaudiUtils/src/Lib/HistoTableFormat.cpp