SeedWriter Class Reference

Inherited by TextFileWriter.

Inheritance diagram for SeedWriter:

Inheritance graph
[legend]
List of all members.

Detailed Description

Abstract writer for seed data files.

Author:
Lawrence Murray <lawrence@indii.org>
Version:
Rev
285
Date:
Date
2007-07-20 17:25:40 +0100 (Fri, 20 Jul 2007)

Definition at line 20 of file SeedWriter.hpp.

Public Member Functions

 SeedWriter (std::ostream *out)
 Construct new seed writer from output stream.
 SeedWriter (const std::string file)
 Construct new seed writer from file.
virtual ~SeedWriter ()
 Destructor.
virtual void write (const double value)=0
 Write single value.
virtual void write (const indii::ml::aux::vector values)=0
 Write vector of values.
virtual void write (const indii::ml::aux::matrix values)=0
 Write matrix of values.
virtual void write (const indii::ml::aux::symmetric_matrix values)=0
 Write symmetric matrix of values.
virtual void writeLine ()=0
 Write the end of the current line and begin a new line.
void writeLine (const double value)
 Convenience method equivalent to calling write(const double) then writeLine().
void writeLine (const indii::ml::aux::vector values)
 Convenience method equivalent to calling write(const indii::ml::aux::vector) then writeLine().
void writeLine (const indii::ml::aux::matrix values)
 Convenience method equivalent to calling write(const indii::ml::aux::matrix) then writeLine().
void writeLine (const indii::ml::aux::symmetric_matrix values)
 Convenience method equivalent to calling write(const indii::ml::aux::symmetric_matrix) then writeLine().

Protected Attributes

std::ostream * out
 The output stream.


Constructor & Destructor Documentation

SeedWriter ( std::ostream *  out  ) 

Construct new seed writer from output stream.

Parameters:
out Stream to which to write.

Definition at line 11 of file SeedWriter.cpp.

SeedWriter ( const std::string  file  ) 

Construct new seed writer from file.

Parameters:
file Name of file to which to write.

Definition at line 15 of file SeedWriter.cpp.

~SeedWriter (  )  [virtual]

Destructor.

The output stream is closed if the object was created using a file name, but left open otherwise.

Definition at line 19 of file SeedWriter.cpp.


Member Function Documentation

virtual void write ( const double  value  )  [pure virtual]

Write single value.

Parameters:
value Value to write.

Implemented in TextFileWriter.

virtual void write ( const indii::ml::aux::vector  values  )  [pure virtual]

Write vector of values.

All values are written to the current line.

Parameters:
values Vector of values to write.

Implemented in TextFileWriter.

virtual void write ( const indii::ml::aux::matrix  values  )  [pure virtual]

Write matrix of values.

All values are written to the current line in column-wise fashion.

Parameters:
values Matrix of values to write.

Implemented in TextFileWriter.

virtual void write ( const indii::ml::aux::symmetric_matrix  values  )  [pure virtual]

Write symmetric matrix of values.

All values from the lower triangle of the matrix are written to the current line in column-wise fashion.

Parameters:
values Matrix of values to write.

Implemented in TextFileWriter.

virtual void writeLine (  )  [pure virtual]

Write the end of the current line and begin a new line.

Implemented in TextFileWriter.

void writeLine ( const double  value  ) 

Convenience method equivalent to calling write(const double) then writeLine().

Definition at line 26 of file SeedWriter.cpp.

void writeLine ( const indii::ml::aux::vector  values  ) 

Convenience method equivalent to calling write(const indii::ml::aux::vector) then writeLine().

void writeLine ( const indii::ml::aux::matrix  values  ) 

Convenience method equivalent to calling write(const indii::ml::aux::matrix) then writeLine().

void writeLine ( const indii::ml::aux::symmetric_matrix  values  ) 

Convenience method equivalent to calling write(const indii::ml::aux::symmetric_matrix) then writeLine().


Member Data Documentation

std::ostream* out [protected]

The output stream.

Definition at line 107 of file SeedWriter.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 9 22:02:10 2007 for fmrii fMRI Modelling Library by  doxygen 1.5.2