Gaudi Framework, version v23r1
Home   Generated: Wed Feb 29 2012
Public Member Functions | Public Attributes

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]

List of all members.

Public Member Functions

 Table (const int ID=0)
 constructor from enum
 Table (const std::string &format, const std::string &header="", const std::string &footer="")
 Constructor from the format, header and footer.
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
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
const std::string & header () const
 the table header
const std::string & footer () const
 the table footer
const std::string & format () const
 the format
void setHeader (const std::string &v)
 set new header
void setFooter (const std::string &v)
 set new footer
void setFormat (const std::string &v)
 set new format
std::string toString (const AIDA::IHistogram1D *histo) const
 make the string representation according to the default format
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

Public Attributes

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

Detailed Description

Simple class for the customizeble printout of the histogram tables.

Author:
Vanya BELYAEV ibelyaev@physics.syr.edu
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.

  : m_header ( Gaudi::Utils::Histos::Formats::header ( ID ) )
  , m_footer ()
  , m_format ( Gaudi::Utils::Histos::Formats::format ( ID ) )
{}
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.

  : m_header ( header )
  , m_footer ( footer )
  , m_format ( format )
{}

Member Function Documentation

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

the table footer

Definition at line 476 of file HistoTableFormat.h.

{ return m_footer ; }
const std::string& Gaudi::Utils::Histos::Table::format (  ) const [inline]

the format

Definition at line 479 of file HistoTableFormat.h.

{ return m_format ; }
const std::string& Gaudi::Utils::Histos::Table::header (  ) const [inline]

the table header

Definition at line 473 of file HistoTableFormat.h.

{ return m_header ; }
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.

        {
          if ( !header().empty() ) { stream << header () << term ; }
          Gaudi::Utils::Histos::printList ( first , last , format() , stream , term ) ;
          if ( !footer().empty() ) { stream << footer () << term ; }
          return stream ;
        }
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.

        {
          if ( !hval.empty() || !header().empty() )
          { stream << Gaudi::Utils::Histos::format ( hval , header() , fmt ) << term ; }
          return Gaudi::Utils::Histos::printMap
            ( first , last , fmt , format() , stream , term ) ;
        }
void Gaudi::Utils::Histos::Table::setFooter ( const std::string &  v ) [inline]

set new footer

Definition at line 487 of file HistoTableFormat.h.

{ m_footer = v ; }
void Gaudi::Utils::Histos::Table::setFormat ( const std::string &  v ) [inline]

set new format

Definition at line 490 of file HistoTableFormat.h.

{ m_format = v ; }
void Gaudi::Utils::Histos::Table::setHeader ( const std::string &  v ) [inline]

set new header

Definition at line 484 of file HistoTableFormat.h.

{ m_header = v ; }
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.

{ return Gaudi::Utils::Histos::format ( histo , format() ) ; }
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.

{ return Gaudi::Utils::Histos::format ( histo , ID , fmt , format() ) ; }

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated at Wed Feb 29 2012 15:31:37 for Gaudi Framework, version v23r1 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004