DataLog Class Reference

#include <datalog.hpp>

Public Member Functions
	~DataLog ()
Category *	category (const std::string &name)
void	removeCategory (const std::string &name)
std::vector< Category * >	categories () const
bool	write (DataLogWriter *writer) const
void	clear ()

Detailed Description

Holds a collection of related categories which can be written out to various formats. This class is conceptually similar to a spreadsheet that holds multiple columns.

Constructor & Destructor Documentation

DataLog::~DataLog

(

)

Member Function Documentation

std::vector<Category *> DataLog::categories

(

)

const

Get a list of all created categories.

Returns

The currently created categories.

Category* DataLog::category

(

const std::string &

name

)

Returns the category instance associated with name.

Parameters

name	The name of the category. This is considered the category's title.

Returns

A new instance of Category if the category doesn't exist yet, or the existing instance if it does.

void DataLog::clear

(

)

Removes all categories from this Data Log

void DataLog::removeCategory

(

const std::string &

name

)

Removes a previously created category.

Parameters

name	The name of the category to remove.

bool DataLog::write

(

DataLogWriter *

writer

)

const

Writes out this Data Log with the given writer.

Returns

true on success, false otherwise.

---

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

• include/kovan/datalog.hpp