faudes::TokenWriter Class Reference

#include <tokenwriter.h>

List of all members.


Detailed Description

A TokenWriter writes sequential tokens to a file, a string or stdout.

It is the counterpart of the TokenReader. Since wrtiting data comparatively straight foreward, there is no explicit support of sections etc. It is left to the calling function to organise the output.

Definition at line 38 of file tokenwriter.h.

Public Types

enum  Mode { File, Stdout, String }
 Mode of operation: write to from file, string or stdout. More...

Public Member Functions

 TokenWriter (Mode mode)
 Console or String TokenWriter constructor.
 TokenWriter (const std::string &rFilename, std::ios::openmode openmode=std::ios::out|std::ios::trunc)
 File TokenWriter constructor.
 ~TokenWriter (void)
 Destructor.
std::string Str (void)
 Retrieve output as string (if in String mode).
int Columns (void) const
 Get number of columns in a line.
void Columns (int columns)
 Set number of columns in a line.
void Endl (void)
 Write endl separator (obmitted in String mode).
void Write (Token &rToken)
 Write next token.
void Write (const std::string &rString)
 Write name.
void Write (Idx index)
 Write index.
void WriteFloat (const double &val)
 Write float.
void WriteOption (const std::string &rOpt)
 Write option.
void WriteBegin (const std::string &rLabel)
 Write begin label.
void WriteEnd (const std::string &rLabel)
 Write end label.
void Comment (const std::string &rComment)
 Write comment.
void operator<< (Token &rToken)
 Operator for writing tokens.
void operator<< (const std::string &rString)
 Operator for writing std::strings to a stream.
void operator<< (const Idx index)
 Operator for writing Idxs to a stream.

Private Attributes

Mode mMode
 output mode
std::ostream * mpStream
 ostream object pointer
std::ofstream mFStream
 actual stream object, file output
std::ostringstream mSStream
 actual stream object, string output
std::string mFileName
 Filename.
int mColumns
 Number of columns.
int mColCount
 Column counter.


Member Enumeration Documentation

enum faudes::TokenWriter::Mode
 

Mode of operation: write to from file, string or stdout.

Enumerator:
File 
Stdout 
String 

Definition at line 45 of file tokenwriter.h.


Constructor & Destructor Documentation

faudes::TokenWriter::TokenWriter Mode  mode  ) 
 

Console or String TokenWriter constructor.

Exceptions:
Exception 

Definition at line 47 of file tokenwriter.cpp.

faudes::TokenWriter::TokenWriter const std::string &  rFilename,
std::ios::openmode  openmode = std::ios::out|std::ios::trunc
 

File TokenWriter constructor.

Parameters:
rFilename File to write
openmode std::ios::openmode
Exceptions:
Exception 

Definition at line 29 of file tokenwriter.cpp.

faudes::TokenWriter::~TokenWriter void   ) 
 

Destructor.

Calls close

Definition at line 81 of file tokenwriter.cpp.


Member Function Documentation

void faudes::TokenWriter::Columns int  columns  ) 
 

Set number of columns in a line.

Parameters:
columns # of columns in a line

Definition at line 101 of file tokenwriter.cpp.

int faudes::TokenWriter::Columns void   )  const
 

Get number of columns in a line.

Returns:
# of columns in a line

Definition at line 96 of file tokenwriter.cpp.

void faudes::TokenWriter::Comment const std::string &  rComment  ) 
 

Write comment.

Parameters:
rComment Comment to write
Exceptions:
Exception 

Definition at line 196 of file tokenwriter.cpp.

void faudes::TokenWriter::Endl void   ) 
 

Write endl separator (obmitted in String mode).

Exceptions:
Exception 

Definition at line 106 of file tokenwriter.cpp.

void faudes::TokenWriter::operator<< const Idx  index  )  [inline]
 

Operator for writing Idxs to a stream.

Parameters:
index Index to write
Exceptions:
Exception 

Definition at line 215 of file tokenwriter.h.

void faudes::TokenWriter::operator<< const std::string &  rString  )  [inline]
 

Operator for writing std::strings to a stream.

Parameters:
rString String to write
Exceptions:
Exception 

Definition at line 203 of file tokenwriter.h.

void faudes::TokenWriter::operator<< Token rToken  )  [inline]
 

Operator for writing tokens.

Parameters:
rToken Token to write
Exceptions:
Exception 

Definition at line 191 of file tokenwriter.h.

std::string faudes::TokenWriter::Str void   ) 
 

Retrieve output as string (if in String mode).

Exceptions:
Exception 

Definition at line 86 of file tokenwriter.cpp.

void faudes::TokenWriter::Write Idx  index  ) 
 

Write index.

Parameters:
index Index to write
Exceptions:
Exception 

Definition at line 159 of file tokenwriter.cpp.

void faudes::TokenWriter::Write const std::string &  rString  ) 
 

Write name.

Parameters:
rString String to write
Exceptions:
Exception 

Definition at line 146 of file tokenwriter.cpp.

void faudes::TokenWriter::Write Token rToken  ) 
 

Write next token.

Parameters:
rToken Token to write
Exceptions:
Exception 

Definition at line 119 of file tokenwriter.cpp.

void faudes::TokenWriter::WriteBegin const std::string &  rLabel  ) 
 

Write begin label.

Parameters:
rLabel End label, e.g. "Alphabet"
Exceptions:
Exception 

Definition at line 182 of file tokenwriter.cpp.

void faudes::TokenWriter::WriteEnd const std::string &  rLabel  ) 
 

Write end label.

Parameters:
rLabel End label, e.g. "Alphabet"
Exceptions:
Exception 

Definition at line 189 of file tokenwriter.cpp.

void faudes::TokenWriter::WriteFloat const double &  val  ) 
 

Write float.

Parameters:
val float to write
Exceptions:
Exception 

Definition at line 166 of file tokenwriter.cpp.

void faudes::TokenWriter::WriteOption const std::string &  rOpt  ) 
 

Write option.

Parameters:
rOpt option to write
Exceptions:
Exception 

Definition at line 174 of file tokenwriter.cpp.


Member Data Documentation

int faudes::TokenWriter::mColCount [private]
 

Column counter.

Definition at line 240 of file tokenwriter.h.

int faudes::TokenWriter::mColumns [private]
 

Number of columns.

Definition at line 237 of file tokenwriter.h.

std::string faudes::TokenWriter::mFileName [private]
 

Filename.

Definition at line 234 of file tokenwriter.h.

std::ofstream faudes::TokenWriter::mFStream [private]
 

actual stream object, file output

Definition at line 228 of file tokenwriter.h.

Mode faudes::TokenWriter::mMode [private]
 

output mode

Definition at line 222 of file tokenwriter.h.

std::ostream* faudes::TokenWriter::mpStream [private]
 

ostream object pointer

Definition at line 225 of file tokenwriter.h.

std::ostringstream faudes::TokenWriter::mSStream [private]
 

actual stream object, string output

Definition at line 231 of file tokenwriter.h.


The documentation for this class was generated from the following files:
Generated on Fri May 9 11:26:48 2008 for libFAUDES 2.09b by  doxygen 1.4.4