MLAPI::MATLABStream Class Reference

Basic stream to save in a MATLAB-compatible file MLAPI objects. More...

#include <MLAPI_MATLABStream.h>

List of all members.

Public Member Functions

 MATLABStream (const string &FileName, bool UseSparse=true)
 Opens the specified file for writing.
 ~MATLABStream ()
 Finally closes the output file.
MATLABStreamoperator<< (const int obj)
 Writes on file the specified integer (on process 0 only).
MATLABStreamoperator<< (const double obj)
 Writes on file the specified double (on process 0 only).
MATLABStreamoperator<< (const string obj)
 Writes on file the specified string on process 0 only.
MATLABStreamoperator<< (const Operator &obj)
 Writes on file input Operator, one process at-a-time, using global ordering.
MATLABStreamoperator<< (const MultiVector &obj)
 Writes on file the input MultiVector, one process at-a-time.
MATLABStreamoperator<< (const Space &obj)
 Writes on file input Space, one process at-a-time.
bool GetUseSparse () const
 Returns true if the stream uses sparse MATLAB format.
void SetUseSparse (const bool UseSparse)
 Toggles the use of sparse MATLAB formats.
string GetFileName () const
 Returns the name of the output file.

Private Member Functions

void Open (const bool FirstTime=false)
 Opens the file stream in append mode, or in write more if FirstTime == true.
void Close ()
 Closes the file stream.

Private Attributes

string FileName_
 Name of output file.
bool UseSparse_
 If true, prints out using sparse MATLAB commands.
FILE * fp_
 FILE pointer.


Detailed Description

For an example of usage, see BlackBoard.cpp

Author:
Marzio Sala, SNL 9214
Date:
Last updated on Feb-05.

Constructor & Destructor Documentation

MLAPI::MATLABStream::MATLABStream ( const string &  FileName,
bool  UseSparse = true 
) [inline]

MLAPI::MATLABStream::~MATLABStream (  )  [inline]


Member Function Documentation

void MLAPI::MATLABStream::Close (  )  [inline, private]

string MLAPI::MATLABStream::GetFileName (  )  const [inline]

bool MLAPI::MATLABStream::GetUseSparse (  )  const [inline]

void MLAPI::MATLABStream::Open ( const bool  FirstTime = false  )  [inline, private]

MATLABStream& MLAPI::MATLABStream::operator<< ( const Space obj  )  [inline]

MATLABStream& MLAPI::MATLABStream::operator<< ( const MultiVector obj  )  [inline]

MATLABStream& MLAPI::MATLABStream::operator<< ( const Operator obj  )  [inline]

MATLABStream& MLAPI::MATLABStream::operator<< ( const string  obj  )  [inline]

MATLABStream& MLAPI::MATLABStream::operator<< ( const double  obj  )  [inline]

MATLABStream& MLAPI::MATLABStream::operator<< ( const int  obj  )  [inline]

void MLAPI::MATLABStream::SetUseSparse ( const bool  UseSparse  )  [inline]


Member Data Documentation

FILE* MLAPI::MATLABStream::fp_ [private]


The documentation for this class was generated from the following file: