TextLog.H File Reference

#include <string>

Include dependency graph for TextLog.H:

This graph shows which files directly or indirectly include this file:

Functions
Logging to a text file
These functions may safely be called from multiple threads.
void	textLog (const std::string &fname, const std::string &event, const std::string &details)
	Log a message to a textlog file.
void	textLog (const std::string &fname, const std::string &event, const std::string &details, const SimTime &t)
	Like before, but give a specific timestamp.
void	setLogTime (const std::string &fname, const SimTime &t)
	Specify the timestamp to be used for subsequent logfile entries.

Detailed Description

Functions for logging model/simulation events

Definition in file TextLog.H.

Function Documentation

void setLogTime	(	const std::string &	fname,
		const SimTime &	t
	)

Specify the timestamp to be used for subsequent logfile entries.

Definition at line 171 of file TextLog.C.

Referenced by SimEventQueue::evolve().

void textLog	(	const std::string &	fname,
		const std::string &	event,
		const std::string &	details,
		const SimTime &	t
	)

Like before, but give a specific timestamp.

Definition at line 161 of file TextLog.C.

void textLog	(	const std::string &	fname,
		const std::string &	event,
		const std::string &	details
	)

Log a message to a textlog file.

This version is for C++ formatted message. If the option was not specified in the command line, this is a no-op. To get a std::string from printf-style formatting, use sformat() from "Util/sformat.H".

Parameters:

	event	short one-word name for event that triggered log entry
	details	additional details about the event

Definition at line 152 of file TextLog.C.

Referenced by SpatialMetrics::paramChanged(), RasterInputSeries::readFrame(), OutputFrameSeries::update(), RasterOutputSeries::writeFrame(), OutputMbariFrameSeries::writeMbariFloat(), OutputMbariFrameSeries::writeMbariGray(), and OutputMbariFrameSeries::writeMbariRGB().