Teuchos::TabularOutputter Class Reference

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

#include <Teuchos_TabularOutputter.hpp>

List of all members.

Classes

class  InvalidFieldOutputError
  More...
class  InvalidFieldSpecError
  More...
class  MissingFieldsError
  More...
class  MissingHeaderError
  More...

Public Types

Public types

enum  EFieldType
  More...
enum  
enum  EFieldJustification
  More...
enum  
enum  EFloatingOutputType
  More...
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.
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.
void setFieldTypePrecision (const EFieldType fieldType, const int prec)
 Set the precision of output for a field.
void outputHeader ()
 Output the headers.
template<typename T >
void outputField (const T &t)
 Output to the next field.
void nextRow (const bool allowRemainingFields=false)
 Finalize the row of output.

Detailed Description

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

Definition at line 48 of file Teuchos_TabularOutputter.hpp.


Member Enumeration Documentation

Definition at line 55 of file Teuchos_TabularOutputter.hpp.

Definition at line 59 of file Teuchos_TabularOutputter.hpp.

Definition at line 63 of file Teuchos_TabularOutputter.hpp.


Constructor & Destructor Documentation

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

Definition at line 71 of file Teuchos_TabularOutputter.cpp.

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

Definition at line 79 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 87 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 96 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 122 of file Teuchos_TabularOutputter.cpp.

void Teuchos::TabularOutputter::outputHeader (  ) 

Output the headers.

Definition at line 129 of file Teuchos_TabularOutputter.cpp.

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

Output to the next field.

Definition at line 232 of file Teuchos_TabularOutputter.hpp.

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

Finalize the row of output.

Definition at line 170 of file Teuchos_TabularOutputter.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 09:57:47 2011 for Teuchos - Trilinos Tools Package by  doxygen 1.6.3