Table class. More...

#include "LArFormattingHelper.h"

Public Member Functions
	Table (const pandora::StringVector &columnTitles, const unsigned int precision=3)
	Table constructor. More...

void	Print () const
	Print the table. More...

template<typename T >
void	AddElement (const T &value, const Style style=REGULAR, const Color color=DEFAULT)
	Add an element to the table into the next (non-separator) column. More...

Private Member Functions
bool	IsSeparatorColumn (const unsigned int column) const
	If the supplied column is a separator (vertical rule) More...

void	PrintColumnTitles () const
	Print the column titles. More...

void	PrintHorizontalLine () const
	Print a horizontal line. More...

void	PrintTableElements () const
	Print the table elements. More...

void	PrintTableCell (const std::string &value, const std::string &format, const unsigned int index) const
	Print a table cell. More...

void	CheckAndSetSeparatorColumn ()
	Check if the next table cell is in a separator column, if so add a blank element. More...

void	UpdateColumnWidth ()
	Update the width of the last column in which an element was added. More...

Private Attributes
const pandora::StringVector	m_columnTitles
	The vector of columns titles in the table. More...

const unsigned int	m_precision
	The number of significant figures to use when displaying number types. More...

pandora::StringVector	m_elements
	The vector of flattened table elements. More...

pandora::StringVector	m_format
	The formatting of each table element. More...

std::vector< unsigned int >	m_widths
	The widths of each column (in units of number of characters) More...

std::stringstream	m_stringstream
	The stringstream to print objects to. More...

Detailed Description

Table class.

Definition at line 128 of file LArFormattingHelper.h.

Constructor & Destructor Documentation

lar_content::LArFormattingHelper::Table::Table	(	const pandora::StringVector &	columnTitles,
		const unsigned int	precision = `3`
	)

Table constructor.

Parameters

columnTitles	the string columns titles use empty string for a separator column
precision	the number of significant figures to display for number type table elements

Definition at line 88 of file LArFormattingHelper.cc.

References m_columnTitles, m_precision, m_stringstream, and m_widths.

                                                                                               :
     m_columnTitles(columnTitles),
     m_precision(precision)
 {
     m_stringstream.precision(m_precision);
 
     for (const std::string &title : m_columnTitles)
         m_widths.push_back(title.length());
 }

Member Function Documentation

template<typename T >

void lar_content::LArFormattingHelper::Table::AddElement	(	const T &	value,
		const Style	style = `REGULAR`,
		const Color	color = `DEFAULT`
	)

inline

Add an element to the table into the next (non-separator) column.

Parameters

value	the element to add to the table
style	the style of the element
color	the color of the element

Definition at line 217 of file LArFormattingHelper.h.

References CheckAndSetSeparatorColumn(), lar_content::LArFormattingHelper::GetFormatCharacter(), m_elements, m_format, m_stringstream, and UpdateColumnWidth().

Referenced by lar_content::LArMonitoringHelper::PrintMatchingTable().

 {
     this->CheckAndSetSeparatorColumn();
 
     if (!(m_stringstream << value))
         throw pandora::StatusCodeException(pandora::STATUS_CODE_INVALID_PARAMETER);
 
     m_elements.push_back(static_cast<std::string>(m_stringstream.str()));
     m_format.push_back(LArFormattingHelper::GetFormatCharacter(style) + LArFormattingHelper::GetFormatCharacter(color));
     m_stringstream.str("");
 
     this->UpdateColumnWidth();
     this->CheckAndSetSeparatorColumn();
 }

void lar_content::LArFormattingHelper::Table::CheckAndSetSeparatorColumn ( )

private

Check if the next table cell is in a separator column, if so add a blank element.

Definition at line 100 of file LArFormattingHelper.cc.

References m_columnTitles, m_elements, and m_format.

Referenced by AddElement().

 {
     if (m_columnTitles[m_elements.size() % m_columnTitles.size()] == "")
     {
         m_format.push_back("");
         m_elements.push_back("");
     }
 }

bool lar_content::LArFormattingHelper::Table::IsSeparatorColumn ( const unsigned int column ) const

private

If the supplied column is a separator (vertical rule)

Parameters

column the column index to check

Returns: true/false

Definition at line 111 of file LArFormattingHelper.cc.

References m_columnTitles.

Referenced by PrintTableCell().

 {
     if (column >= m_columnTitles.size())
         throw StatusCodeException(STATUS_CODE_OUT_OF_RANGE);
 
     return (m_columnTitles[column] == "");
 }

void lar_content::LArFormattingHelper::Table::Print ( ) const

Print the table.

Definition at line 133 of file LArFormattingHelper.cc.

References m_columnTitles, PrintColumnTitles(), PrintHorizontalLine(), and PrintTableElements().

Referenced by lar_content::LArMonitoringHelper::PrintMatchingTable().

 {
     if (m_columnTitles.empty())
         return;
 
     this->PrintColumnTitles();
     this->PrintHorizontalLine();
     this->PrintTableElements();
 }

void lar_content::LArFormattingHelper::Table::PrintColumnTitles ( ) const

private

Print the column titles.

Parameters

widths a vector of the number of characters to include in each column

Definition at line 145 of file LArFormattingHelper.cc.

References lar_content::LArFormattingHelper::BOLD, lar_content::LArFormattingHelper::GetFormatCharacter(), m_columnTitles, and PrintTableCell().

Referenced by Print().

 {
     for (unsigned int i = 0, nColumns = m_columnTitles.size(); i < nColumns; ++i)
         this->PrintTableCell(m_columnTitles[i], LArFormattingHelper::GetFormatCharacter(LArFormattingHelper::BOLD), i);
 }

void lar_content::LArFormattingHelper::Table::PrintHorizontalLine ( ) const

private

Print a horizontal line.

Parameters

widths a vector of the number of characters to include in each column

Definition at line 153 of file LArFormattingHelper.cc.

References lar_content::LArFormattingHelper::GetFormatCharacter(), m_columnTitles, m_widths, PrintTableCell(), and lar_content::LArFormattingHelper::REGULAR.

Referenced by Print().

 {
     for (unsigned int i = 0, nColumns = m_columnTitles.size(); i < nColumns; ++i)
         this->PrintTableCell(std::string(m_widths[i], '-'), LArFormattingHelper::GetFormatCharacter(LArFormattingHelper::REGULAR), i);
 }

void lar_content::LArFormattingHelper::Table::PrintTableCell	(	const std::string &	value,
		const std::string &	format,
		const unsigned int	index
	)		const

private

Print a table cell.

Parameters

value	the string to print in the cell
format	a formatting string (see GetFormatCharacter(...))
index	the index of the table cell (0 –> number of elements) used to find the column
widths	a vector of the number of characters to include in each column

Definition at line 180 of file LArFormattingHelper.cc.

References IsSeparatorColumn(), m_columnTitles, m_widths, and lar_content::LArFormattingHelper::ResetStyle().

Referenced by PrintColumnTitles(), PrintHorizontalLine(), and PrintTableElements().

 {
     if (m_columnTitles.empty())
         return;
 
     const unsigned int column(index % m_widths.size());
 
     const std::string separator(this->IsSeparatorColumn(column) ? "" : " ");
     std::cout << "|" << format << separator << std::setw(m_widths[column]) << std::internal << value << separator
               << std::resetiosflags(std::ios::adjustfield);
     LArFormattingHelper::ResetStyle();
 
     if (column == m_columnTitles.size() - 1)
         std::cout << "|" << std::endl;
 }

void lar_content::LArFormattingHelper::Table::PrintTableElements ( ) const

private

Print the table elements.

Parameters

widths a vector of the number of characters to include in each column

Definition at line 161 of file LArFormattingHelper.cc.

References m_columnTitles, m_elements, m_format, and PrintTableCell().

Referenced by Print().

 {
     if (m_columnTitles.empty())
         return;
 
     const unsigned int nRows((m_elements.size() + m_columnTitles.size() - 1) / m_columnTitles.size());
     const unsigned int nColumns(m_columnTitles.size());
     if (nRows * nColumns != m_elements.size())
     {
         std::cout << "LArFormattingHelper::Table::PrintTableElements - Error: Number of table elements added doesn't fill a whole row" << std::endl;
         throw StatusCodeException(STATUS_CODE_OUT_OF_RANGE);
     }
 
     for (unsigned int i = 0; i < nRows * nColumns; i++)
         this->PrintTableCell(m_elements[i], m_format[i], i);
 }

void lar_content::LArFormattingHelper::Table::UpdateColumnWidth ( )

private

Update the width of the last column in which an element was added.

Definition at line 121 of file LArFormattingHelper.cc.

References m_elements, and m_widths.

Referenced by AddElement().

 {
     if (m_widths.empty() || m_elements.empty())
         throw StatusCodeException(STATUS_CODE_OUT_OF_RANGE);
 
     const unsigned int currentElementIndex(m_elements.size() - 1);
     const unsigned int column(currentElementIndex % m_widths.size());
     m_widths[column] = std::max(static_cast<unsigned int>(m_elements[currentElementIndex].length()), m_widths[column]);
 }

Member Data Documentation

const pandora::StringVector lar_content::LArFormattingHelper::Table::m_columnTitles

private

The vector of columns titles in the table.

Definition at line 205 of file LArFormattingHelper.h.

Referenced by CheckAndSetSeparatorColumn(), IsSeparatorColumn(), Print(), PrintColumnTitles(), PrintHorizontalLine(), PrintTableCell(), PrintTableElements(), and Table().

pandora::StringVector lar_content::LArFormattingHelper::Table::m_elements

private

The vector of flattened table elements.

Definition at line 207 of file LArFormattingHelper.h.

Referenced by AddElement(), CheckAndSetSeparatorColumn(), PrintTableElements(), and UpdateColumnWidth().

pandora::StringVector lar_content::LArFormattingHelper::Table::m_format

private

The formatting of each table element.

Definition at line 208 of file LArFormattingHelper.h.

Referenced by AddElement(), CheckAndSetSeparatorColumn(), and PrintTableElements().

const unsigned int lar_content::LArFormattingHelper::Table::m_precision

private

The number of significant figures to use when displaying number types.

Definition at line 206 of file LArFormattingHelper.h.

Referenced by Table().

std::stringstream lar_content::LArFormattingHelper::Table::m_stringstream

private

The stringstream to print objects to.

Definition at line 210 of file LArFormattingHelper.h.

Referenced by AddElement(), and Table().

std::vector<unsigned int> lar_content::LArFormattingHelper::Table::m_widths

private

The widths of each column (in units of number of characters)

Definition at line 209 of file LArFormattingHelper.h.

Referenced by PrintHorizontalLine(), PrintTableCell(), Table(), and UpdateColumnWidth().

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

larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArFormattingHelper.h
larpandoracontent/v04_08_01/source/larpandoracontent/LArHelpers/LArFormattingHelper.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation