robowflex::JSONPlanDataSetOutputter Class Reference

A benchmark outputter for storing data in a single JSON file. More...

#include <benchmarking.h>

Inheritance diagram for robowflex::JSONPlanDataSetOutputter:

Public Member Functions
	JSONPlanDataSetOutputter (const std::string &file)
	Constructor. More...
	~JSONPlanDataSetOutputter () override
	Destructor. Closes outfile_. More...
void	dump (const PlanDataSet &results) override
	Dumps results into outfile_, and opens outfile_ if not already done so. More...
Public Member Functions inherited from robowflex::PlanDataSetOutputter
virtual	~PlanDataSetOutputter ()=default
	Virtual destructor for cleaning up resources. More...

Private Attributes
bool	is_init_ {false}
	Have we initialized the outputter (on first result)? More...
const std::string	file_
	Filename to open. More...
std::ofstream	outfile_
	Output stream. More...

Detailed Description

A benchmark outputter for storing data in a single JSON file.

Definition at line 522 of file benchmarking.h.

Constructor & Destructor Documentation

JSONPlanDataSetOutputter()

JSONPlanDataSetOutputter::JSONPlanDataSetOutputter

(

const std::string &

file

)

Constructor.

Parameters

[in]

file

Filename to save results to.

JSONPlanDataSetOutputter

Definition at line 532 of file benchmarking.cpp.

                                                                        : file_(file)
{
}

~JSONPlanDataSetOutputter()

JSONPlanDataSetOutputter::~JSONPlanDataSetOutputter ( )

override

Destructor. Closes outfile_.

Definition at line 536 of file benchmarking.cpp.

{
    outfile_ << "}" << std::endl;
    outfile_.close();
}

Member Function Documentation

dump()

void JSONPlanDataSetOutputter::dump ( const PlanDataSet &  results )

overridevirtual

Dumps results into outfile_, and opens outfile_ if not already done so.

Parameters

[in]

results

Results to dump to file.

Implements robowflex::PlanDataSetOutputter.

Definition at line 542 of file benchmarking.cpp.

{
    if (not is_init_)
    {
        IO::createFile(outfile_, file_);
        outfile_ << "{";
        // TODO: output specific information about the scene and planner structs?
 
        is_init_ = true;
    }
    else
        outfile_ << ",";
 
    outfile_ << "\"" << results.name << "\":[";
 
    const auto &data = results.getFlatData();
 
    for (size_t i = 0; i < data.size(); i++)
    {
        const auto &run = data[i];
        outfile_ << "{";
 
        outfile_ << "\"name\": \"run_" << run->query.name << "\",";
        outfile_ << "\"time\":" << run->time << ",";
        outfile_ << "\"success\":" << run->success;
 
        for (const auto &metric : run->metrics)
            outfile_ << ",\"" << metric.first << "\":" << toMetricString(metric.second);
 
        outfile_ << "}";
 
        // Write the command between each run.
        if (i != data.size() - 1)
            outfile_ << "," << std::endl;
    }
 
    outfile_ << "]";
}

Member Data Documentation

file_

const std::string robowflex::JSONPlanDataSetOutputter::file_

private

Filename to open.

Definition at line 541 of file benchmarking.h.

is_init_

bool robowflex::JSONPlanDataSetOutputter::is_init_ {false}

private

Have we initialized the outputter (on first result)?

Definition at line 540 of file benchmarking.h.

outfile_

std::ofstream robowflex::JSONPlanDataSetOutputter::outfile_

private

Output stream.

Definition at line 542 of file benchmarking.h.

---

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

• benchmarking.h
• benchmarking.cpp