Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Teuchos::TableEntry Class Referenceabstract

An entry, perhaps compound, to be written into a table. More...

#include <Teuchos_TableEntry.hpp>

Inheritance diagram for Teuchos::TableEntry:
Inheritance graph
[legend]

Public Member Functions

 TableEntry ()
 Empty ctor. More...
 
virtual ~TableEntry ()
 virtual dtor More...
 
virtual std::string toString () const =0
 Return a std::string representation of this entry. More...
 
virtual std::string toChoppedString (int maxWidth) const
 Return a std::string representation of this entry, truncated if necessary to fit within the given column width. More...
 

Detailed Description

An entry, perhaps compound, to be written into a table.

KL 30 Apr 2006 – initial design. Can you say overengineering?? The complexity is to support a nice interface for pair entries such as time/numCalls.

Definition at line 37 of file Teuchos_TableEntry.hpp.

Constructor & Destructor Documentation

Teuchos::TableEntry::TableEntry ( )
inline

Empty ctor.

Definition at line 41 of file Teuchos_TableEntry.hpp.

virtual Teuchos::TableEntry::~TableEntry ( )
inlinevirtual

virtual dtor

Definition at line 44 of file Teuchos_TableEntry.hpp.

Member Function Documentation

virtual std::string Teuchos::TableEntry::toString ( ) const
pure virtual

Return a std::string representation of this entry.

Implemented in Teuchos::CompoundEntryWithParentheses, Teuchos::StringEntry, Teuchos::IntEntry, and Teuchos::DoubleEntry.

std::string TableEntry::toChoppedString ( int  maxWidth) const
virtual

Return a std::string representation of this entry, truncated if necessary to fit within the given column width.

Parameters
maxWidth[in] the maximum width of the std::string form. Larger strings must be truncated in a subclass-dependent way.
Returns
the std::string, truncated if necessary

Definition at line 17 of file Teuchos_TableEntry.cpp.


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