StreamerBase Class Reference

#include <StreamerBase.h>

Inheritance diagram for StreamerBase:

Collaboration diagram for StreamerBase:

Public Member Functions
string	getOutFilepath () const
StreamerBase &	operator= (const StreamerBase &st)
void	setOutFilepath (string stream)
	StreamerBase ()
	~StreamerBase ()
Public Member Functions inherited from TableBase
void	clearVec ()
void	compareVec (vector< double > other, string op)
void	compareXplot (string fname, string plotname, string op)
const vector< double > &	data ()
double	getOutputValue () const
string	getPlotDump () const
vector< double >	getVec () const
unsigned int	getVecSize () const
double	getY (unsigned int index) const
double	interpolate (double x, double xmin, double xmax) const
void	linearTransform (double scale, double offset)
void	loadCSV (string fname, int startLine, int colNum, char separator)
void	loadXplot (string fname, string plotname)
void	loadXplotRange (string fname, string plotname, unsigned int start, unsigned int end)
double *	lookupVec (unsigned int index)
void	plainPlot (string file)
void	setOutputValue (double val)
void	setPlotDump (string v)
void	setVec (vector< double > val)
void	setVecSize (unsigned int num)
	TableBase ()
void	xplot (string file, string plotname)

Static Public Member Functions
static void	writeToCSVFile (const string &filepath, const string &openmode, const vector< double > &data, const vector< string > &columns)
	Write data to csv file. See the documentation of writeToOutfile for details. More...
static void	writeToNPYFile (const string &filepath, const string &openmode, const vector< double > &data, const vector< string > &columns)
	Write to NPY format. See the documentation of writeToOutfile for more details. More...
static void	writeToOutFile (const string &filepath, const string &format, const string &openmode, const vector< double > &data, const vector< string > &columns)
	Write to a output file in given format. More...
Static Public Member Functions inherited from TableBase
static const Cinfo *	initCinfo ()

Private Attributes
string	outfilePath_

Static Private Attributes
static const char	delimiter_ = ' '
static const char	eol = '\n'

Additional Inherited Members
Protected Member Functions inherited from TableBase
vector< double > &	vec ()

Detailed Description

Definition at line 31 of file StreamerBase.h.

Constructor & Destructor Documentation

StreamerBase::StreamerBase

(

)

Definition at line 30 of file StreamerBase.cpp.

{
}

StreamerBase::~StreamerBase

(

)

Definition at line 41 of file StreamerBase.cpp.

{

}

Member Function Documentation

string StreamerBase::getOutFilepath

(

void

)

const

Definition at line 47 of file StreamerBase.cpp.

References outfilePath_.

{
    return outfilePath_;
}

StreamerBase & StreamerBase::operator=

(

const StreamerBase &

st

)

Definition at line 34 of file StreamerBase.cpp.

References outfilePath_.

{
    this->outfilePath_ = st.outfilePath_;
    return *this;
}

void StreamerBase::setOutFilepath

(

string

stream

)

Definition at line 52 of file StreamerBase.cpp.

References outfilePath_.

{
    outfilePath_ = filepath;
}

void StreamerBase::writeToCSVFile ( const string &  filepath, const string &  openmode, const vector< double > &  data, const vector< string > &  columns  )

static

Write data to csv file. See the documentation of writeToOutfile for details.

Definition at line 83 of file StreamerBase.cpp.

References delimiter_, eol, LOG, moose::toString(), and moose::warning.

Referenced by writeToOutFile().

{

    FILE* fp = fopen( filepath.c_str(), openmode.c_str() );
    if( NULL == fp )
    {
        LOG( moose::warning, "Failed to open " << filepath );
        return;
    }

    // If writing in "w" mode, write the header first.
    if( openmode == "w" )
    {
        string headerText = "";
        for( vector<string>::const_iterator it = columns.begin();
            it != columns.end(); it++ )
            headerText += ( *it + delimiter_ );
        headerText += eol;
        fprintf( fp, "%s", headerText.c_str() );
    }

    string text = "";
    for( size_t i = 0; i < data.size(); i+=columns.size() )
    {
        // Start of a new row.
        for( size_t ii = 0; ii < columns.size(); ii++ )
            text += moose::toString( data[i+ii] ) + delimiter_;

        // At the end of each row, we remove the delimiter_ and append newline_.
        *(text.end()-1) = eol;
    }
    fprintf( fp, "%s", text.c_str() );
    fclose( fp );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void StreamerBase::writeToNPYFile ( const string &  filepath, const string &  openmode, const vector< double > &  data, const vector< string > &  columns  )

static

Write to NPY format. See the documentation of writeToOutfile for more details.

Definition at line 120 of file StreamerBase.cpp.

References TableBase::data().

Referenced by writeToOutFile().

{
    cnpy2::save_numpy<double>( filepath, data, columns, openmode );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void StreamerBase::writeToOutFile ( const string &  filepath, const string &  format, const string &  openmode, const vector< double > &  data, const vector< string > &  columns  )

static

Write to a output file in given format.

Parameters

filepath,path	of output file. If parent directories do not exist, they will be created. If creation fails for some reason, data will be saved in current working directory. The name of the file will be computed from the given directory name by replacing '/' or '\' by '_'.
format	npy : numpy binary format (version 1 and 2), version 1 is default. csv or dat: comma separated value (delimiter ' ' )
openmode	(write or append)
data,vector	of values
ncols	(number of columns). Incoming data will be formatted into a matrix with ncols.

Definition at line 58 of file StreamerBase.cpp.

References LOG, moose::warning, writeToCSVFile(), and writeToNPYFile().

Referenced by Streamer::cleanUp(), Table::process(), Streamer::process(), Table::reinit(), Streamer::reinit(), and Table::~Table().

{
    if( data.size() == 0 )
        return;

    if( "npy" == outputFormat )
        writeToNPYFile( filepath, openmode, data, columns );
    else if( "csv" == outputFormat or "dat" == outputFormat )
        writeToCSVFile( filepath, openmode, data, columns );
    else
    {
        LOG( moose::warning, "Unsupported format " << outputFormat
                << ". Use npy or csv. Falling back to default csv"
           );
        writeToCSVFile( filepath, openmode, data, columns );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const char StreamerBase::delimiter_ = ' '

staticprivate

Definition at line 94 of file StreamerBase.h.

Referenced by writeToCSVFile().

const char StreamerBase::eol = '\n'

staticprivate

Definition at line 93 of file StreamerBase.h.

Referenced by writeToCSVFile().

string StreamerBase::outfilePath_

private

Definition at line 91 of file StreamerBase.h.

Referenced by getOutFilepath(), operator=(), and setOutFilepath().

---

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

• moose-core/builtins/StreamerBase.h
• moose-core/builtins/StreamerBase.cpp