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 | FileName (void) const |
| Get the filename.
|
Mode | DestMode (void) const |
| Get file mode.
|
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.
|
void | Endl (bool on) |
| Turn endl separator on/off.
|
void | Write (Token &rToken) |
| Write next token.
|
void | WriteString (const std::string &rString) |
| Write string (may not contain any quotes.
|
void | WriteInteger (Idx index) |
| Write non negative integer.
|
void | WriteFloat (const double &val) |
| Write float.
|
void | WriteInteger16 (long int val) |
| Write integer as hex.
|
void | WriteOption (const std::string &rOpt) |
| Write option (may not contain any "+").
|
void | WriteBegin (const std::string &rLabel) |
| Write begin label.
|
void | WriteEnd (const std::string &rLabel) |
| Write end label.
|
void | WriteComment (const std::string &rComment) |
| Write comment.
|
void | WriteBinary (const char *pData, long int len) |
| Write comment.
|
TokenWriter & | operator<< (Token &rToken) |
| Operator for writing tokens.
|
TokenWriter & | operator<< (const std::string &rString) |
| Operator for writing std::strings to a stream.
|
TokenWriter & | 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.
|
bool | mEndl |
| Endl seperator on/off.
|
Member Enumeration Documentation
Mode of operation: write to from file, string or stdout.
- Enumerator:
-
Definition at line 45 of file tokenwriter.h.
Constructor & Destructor Documentation
faudes::TokenWriter::TokenWriter |
( |
Mode |
mode |
) |
|
Console or String TokenWriter constructor.
Technical detail: the console tokenwriter holds a ref. to std::cout; it will behave strange and perhaps cause segfaults if it is instantiated befor std::cout is up; you can avoid this issue by instantiating you console tokenwriter using the new operator.
- Exceptions:
-
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:
-
Definition at line 29 of file tokenwriter.cpp.
faudes::TokenWriter::~TokenWriter |
( |
void |
|
) |
|
Member Function Documentation
std::string faudes::TokenWriter::FileName |
( |
void |
|
) |
const |
Get the filename.
Return dummy values for console or string mode.
- Returns:
- Filename
Definition at line 242 of file tokenwriter.cpp.
Mode faudes::TokenWriter::DestMode |
( |
void |
|
) |
const [inline] |
std::string faudes::TokenWriter::Str |
( |
void |
|
) |
|
int faudes::TokenWriter::Columns |
( |
void |
|
) |
const |
Get number of columns in a line.
- Returns:
- # of columns in a line
Definition at line 102 of file tokenwriter.cpp.
void faudes::TokenWriter::Columns |
( |
int |
columns |
) |
|
Set number of columns in a line.
- Parameters:
-
| columns | # of columns in a line |
Definition at line 107 of file tokenwriter.cpp.
void faudes::TokenWriter::Endl |
( |
void |
|
) |
|
void faudes::TokenWriter::Endl |
( |
bool |
on |
) |
|
void faudes::TokenWriter::Write |
( |
Token & |
rToken |
) |
|
void faudes::TokenWriter::WriteString |
( |
const std::string & |
rString |
) |
|
Write string (may not contain any quotes.
- Parameters:
-
- Exceptions:
-
Definition at line 159 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteInteger |
( |
Idx |
index |
) |
|
Write non negative integer.
- Parameters:
-
- Exceptions:
-
Definition at line 172 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteFloat |
( |
const double & |
val |
) |
|
void faudes::TokenWriter::WriteInteger16 |
( |
long int |
val |
) |
|
Write integer as hex.
- Parameters:
-
- Exceptions:
-
Definition at line 179 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteOption |
( |
const std::string & |
rOpt |
) |
|
Write option (may not contain any "+").
- Parameters:
-
- Exceptions:
-
Definition at line 194 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteBegin |
( |
const std::string & |
rLabel |
) |
|
Write begin label.
- Parameters:
-
| rLabel | End label, e.g. "Alphabet" |
- Exceptions:
-
Definition at line 202 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteEnd |
( |
const std::string & |
rLabel |
) |
|
Write end label.
- Parameters:
-
| rLabel | End label, e.g. "Alphabet" |
- Exceptions:
-
Definition at line 209 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteComment |
( |
const std::string & |
rComment |
) |
|
Write comment.
- Parameters:
-
| rComment | Comment to write |
- Exceptions:
-
Definition at line 216 of file tokenwriter.cpp.
void faudes::TokenWriter::WriteBinary |
( |
const char * |
pData, |
|
|
long int |
len | |
|
) |
| | |
Write comment.
- Parameters:
-
| len | Number of bytes to write |
| pData | Data to write |
- Exceptions:
-
Definition at line 237 of file tokenwriter.cpp.
Operator for writing tokens.
- Parameters:
-
- Returns:
- Reference to this TokenWriter
- Exceptions:
-
Definition at line 244 of file tokenwriter.h.
TokenWriter& faudes::TokenWriter::operator<< |
( |
const std::string & |
rString |
) |
[inline] |
Operator for writing std::strings to a stream.
- Parameters:
-
- Returns:
- Reference to this TokenWriter
- Exceptions:
-
Definition at line 259 of file tokenwriter.h.
TokenWriter& faudes::TokenWriter::operator<< |
( |
const Idx |
index |
) |
[inline] |
Operator for writing Idxs to a stream.
- Parameters:
-
- Returns:
- Reference to this TokenWriter
- Exceptions:
-
Definition at line 274 of file tokenwriter.h.
Member Data Documentation
Actual stream object, file output.
Definition at line 288 of file tokenwriter.h.
Actual stream object, string output.
Definition at line 291 of file tokenwriter.h.
The documentation for this class was generated from the following files: