Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | List of all members
Teuchos::TabularOutputter Class Reference

Utility class that makes it easy to create formatted tables of output. More...

#include <Teuchos_TabularOutputter.hpp>

Classes

class  InvalidFieldOutputError
 
class  InvalidFieldSpecError
 
class  MissingFieldsError
 
class  MissingHeaderError
 

Public Types

Public types
enum  EFieldType
 
enum  
 
enum  EFieldJustification
 
enum  
 
enum  EFloatingOutputType
 
enum  
 

Public Member Functions

 TabularOutputter (std::ostream &out)
 
 TabularOutputter (const RCP< std::ostream > &out)
 
void setOStream (const RCP< std::ostream > &out)
 Set the ostream that all output will be sent to. More...
 
void pushFieldSpec (const std::string &fieldName, const EFieldType fieldType=DOUBLE, const EFieldJustification fieldJustification=RIGHT, const EFloatingOutputType floatingOutputType=SCIENTIFIC, const int width=-1)
 Add a new field to be output. More...
 
void setFieldTypePrecision (const EFieldType fieldType, const int prec)
 Set the precision of output for a field. More...
 
void outputHeader ()
 Output the headers. More...
 
template<typename T >
void outputField (const T &t)
 Output to the next field. More...
 
void nextRow (const bool allowRemainingFields=false)
 Finalize the row of output. More...
 

Detailed Description

Utility class that makes it easy to create formatted tables of output.

Definition at line 61 of file Teuchos_TabularOutputter.hpp.

Member Enumeration Documentation

enum Teuchos::TabularOutputter::EFieldType

Definition at line 68 of file Teuchos_TabularOutputter.hpp.

enum Teuchos::TabularOutputter::EFieldJustification

Definition at line 72 of file Teuchos_TabularOutputter.hpp.

enum Teuchos::TabularOutputter::EFloatingOutputType

Definition at line 76 of file Teuchos_TabularOutputter.hpp.

Constructor & Destructor Documentation

Teuchos::TabularOutputter::TabularOutputter ( std::ostream &  out)

Definition at line 84 of file Teuchos_TabularOutputter.cpp.

Teuchos::TabularOutputter::TabularOutputter ( const RCP< std::ostream > &  out)

Definition at line 93 of file Teuchos_TabularOutputter.cpp.

Member Function Documentation

void Teuchos::TabularOutputter::setOStream ( const RCP< std::ostream > &  out)

Set the ostream that all output will be sent to.

Definition at line 102 of file Teuchos_TabularOutputter.cpp.

void Teuchos::TabularOutputter::pushFieldSpec ( const std::string &  fieldName,
const EFieldType  fieldType = DOUBLE,
const EFieldJustification  fieldJustification = RIGHT,
const EFloatingOutputType  floatingOutputType = SCIENTIFIC,
const int  width = -1 
)

Add a new field to be output.

Definition at line 111 of file Teuchos_TabularOutputter.cpp.

void Teuchos::TabularOutputter::setFieldTypePrecision ( const EFieldType  fieldType,
const int  prec 
)

Set the precision of output for a field.

This will also determine the width of the field.

Definition at line 137 of file Teuchos_TabularOutputter.cpp.

void Teuchos::TabularOutputter::outputHeader ( )

Output the headers.

Definition at line 144 of file Teuchos_TabularOutputter.cpp.

template<typename T >
void Teuchos::TabularOutputter::outputField ( const T &  t)

Output to the next field.

Definition at line 245 of file Teuchos_TabularOutputter.hpp.

void Teuchos::TabularOutputter::nextRow ( const bool  allowRemainingFields = false)

Finalize the row of output.

Definition at line 185 of file Teuchos_TabularOutputter.cpp.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5