InMemoryReport Class Reference

#include <ored/report/inmemoryreport.hpp>

Inheritance diagram for InMemoryReport:

Collaboration diagram for InMemoryReport:

Public Member Functions
	InMemoryReport ()
Report &	addColumn (const string &name, const ReportType &rt, Size precision=0) override
Report &	next () override
Report &	add (const ReportType &rt) override
Report &	add (const InMemoryReport &report)
void	end () override
Size	columns () const
Size	rows () const
const string &	header (Size i) const
bool	hasHeader (string h) const
ReportType	columnType (Size i) const
Size	columnPrecision (Size i) const
const vector< ReportType > &	data (Size i) const
	Returns the data. More...
void	toFile (const string &filename, const char sep=',', const bool commentCharacter=true, char quoteChar='\0', const string &nullString="#N/A", bool lowerHeader=false)
void	jumpToColumn (Size i)
Public Member Functions inherited from Report
virtual	~Report ()
virtual Report &	addColumn (const string &name, const ReportType &, Size precision=0)=0
virtual Report &	next ()=0
virtual Report &	add (const ReportType &rt)=0
virtual void	end ()=0
virtual void	flush ()

Private Attributes
Size	i_
vector< string >	headers_
vector< ReportType >	columnTypes_
vector< Size >	columnPrecision_
vector< vector< ReportType > >	data_

Additional Inherited Members
Public Types inherited from Report
typedef boost::variant< Size, Real, string, Date, Period >	ReportType

Detailed Description

InMemoryReport just stores report information in local vectors and provides an interface to access the values. It could be used as a backend to a GUI

Definition at line 41 of file inmemoryreport.hpp.

Constructor & Destructor Documentation

InMemoryReport()

InMemoryReport

(

)

Definition at line 43 of file inmemoryreport.hpp.

: i_(0) {}

Member Function Documentation

addColumn()

Report & addColumn ( const string &  name, const ReportType &  rt, Size  precision = 0  )

overridevirtual

Implements Report.

Definition at line 26 of file inmemoryreport.cpp.

                                                                                          {
    headers_.push_back(name);
    columnTypes_.push_back(rt);
    columnPrecision_.push_back(precision);
    data_.push_back(vector<ReportType>()); // Initialise vector for
    i_++;
    return *this;
}

next()

Report & next ( )

overridevirtual

Implements Report.

Definition at line 35 of file inmemoryreport.cpp.

                             {
    QL_REQUIRE(i_ == headers_.size(), "Cannot go to next line, only " << i_ << " entires filled, report headers are: "
                                                                      << boost::join(headers_, ","));
    i_ = 0;
    return *this;
}

Here is the caller graph for this function:

add() [1/2]

Report & add ( const ReportType &  rt )

overridevirtual

Implements Report.

Definition at line 42 of file inmemoryreport.cpp.

                                                {
    // check type is valid
    QL_REQUIRE(i_ < headers_.size(), "No column to add [" << rt << "] to.");
    QL_REQUIRE(rt.which() == columnTypes_[i_].which(), "Cannot add value "
                                                           << rt << " of type " << rt.which() << " to column "
                                                           << headers_[i_] << " of type " << columnTypes_[i_].which()
                                                           << ", report headers are: " << boost::join(headers_, ","));
 
    data_[i_].push_back(rt);
    i_++;
    return *this;
}

Here is the caller graph for this function:

add() [2/2]

Report & add

(

const InMemoryReport &

report

)

Definition at line 55 of file inmemoryreport.cpp.

                                                        {
    QL_REQUIRE(columns() == report.columns(), "Cannot combine reports of different sizes ("
                                                  << columns() << " vs " << report.columns()
                                                  << "), report headers are: " << boost::join(headers_, ","));
    end();
    for (Size i = 0; i < columns(); i++) {
        string h1 = headers_[i];
        string h2 = report.header(i);
        QL_REQUIRE(h1 == h2, "Cannot combine reports with different headers (\""
                                 << h1 << "\" and \"" << h2
                                 << "\"), report headers are: " << boost::join(headers_, ","));
    }
 
    if (i_ == headers_.size())
        next();
        
    for (Size rowIdx = 0; rowIdx < report.rows(); rowIdx++) {
        for (Size columnIdx = 0; columnIdx < report.columns(); columnIdx++) {
            add(report.data(columnIdx)[rowIdx]);
        }
        next();
    }
        
    return *this;
}

Here is the call graph for this function:

end()

void end ( )

overridevirtual

Implements Report.

Definition at line 81 of file inmemoryreport.cpp.

                         {
    QL_REQUIRE(i_ == headers_.size() || i_ == 0, "report is finalized with incomplete row, got data for "
                                                     << i_ << " columns out of " << columns()
                                                     << ", report headers are: " << boost::join(headers_, ","));
}

Here is the call graph for this function:

Here is the caller graph for this function:

columns()

Size columns

(

)

const

Definition at line 52 of file inmemoryreport.hpp.

{ return headers_.size(); }

Here is the caller graph for this function:

rows()

Size rows

(

)

const

Definition at line 53 of file inmemoryreport.hpp.

{ return columns() == 0 ? 0 : data_[0].size(); }

Here is the call graph for this function:

Here is the caller graph for this function:

header()

const string & header

(

Size

i

)

const

Definition at line 54 of file inmemoryreport.hpp.

{ return headers_[i]; }

Here is the caller graph for this function:

hasHeader()

bool hasHeader

(

string

h

)

const

Definition at line 55 of file inmemoryreport.hpp.

{ return std::find(headers_.begin(), headers_.end(), h) != headers_.end(); }

columnType()

ReportType columnType

(

Size

i

)

const

Definition at line 56 of file inmemoryreport.hpp.

{ return columnTypes_[i]; }

columnPrecision()

Size columnPrecision

(

Size

i

)

const

Definition at line 57 of file inmemoryreport.hpp.

{ return columnPrecision_[i]; }

data()

const vector< Report::ReportType > & data

(

Size

i

)

const

Returns the data.

Definition at line 87 of file inmemoryreport.cpp.

                                                                 {
    QL_REQUIRE(data_[i].size() == rows(), "internal error: report column "
                                              << i << " (" << header(i) << ") contains " << data_[i].size()
                                              << " rows, expected are " << rows()
                                              << " rows, report headers are: " << boost::join(headers_, ","));
    return data_[i];
}

Here is the call graph for this function:

Here is the caller graph for this function:

toFile()

void toFile	(	const string &	filename,
		const char	sep = ',',
		const bool	commentCharacter = true,
		char	quoteChar = '\0',
		const string &	nullString = "#N/A",
		bool	lowerHeader = false
	)

Definition at line 95 of file inmemoryreport.cpp.

                                                                        {
 
    CSVFileReport cReport(filename, sep, commentCharacter, quoteChar, nullString, lowerHeader);
 
    for (Size i = 0; i < headers_.size(); i++) {
        cReport.addColumn(headers_[i], columnTypes_[i], columnPrecision_[i]);
    }
 
    auto numColumns = columns();
    if (numColumns > 0) {
        auto numRows = data_[0].size();
 
        for (Size i = 0; i < numRows; i++) {
            cReport.next();
            for (Size j = 0; j < numColumns; j++) {
                cReport.add(data_[j][i]);
            }
        }
    }
 
    cReport.end();
}

Here is the call graph for this function:

jumpToColumn()

void jumpToColumn

(

Size

i

)

Definition at line 62 of file inmemoryreport.hpp.

{ i_ = i; }

Member Data Documentation

i_

Size i_

private

Definition at line 65 of file inmemoryreport.hpp.

headers_

vector<string> headers_

private

Definition at line 66 of file inmemoryreport.hpp.

columnTypes_

vector<ReportType> columnTypes_

private

Definition at line 67 of file inmemoryreport.hpp.

columnPrecision_

vector<Size> columnPrecision_

private

Definition at line 68 of file inmemoryreport.hpp.

data_

vector<vector<ReportType> > data_

private

Definition at line 69 of file inmemoryreport.hpp.