ZLogger Class Reference

#include <ZLogger.h>

List of all members.

---

Detailed Description

A class for logging runtime information and fault data for the ZTrackerTransform filter.

Public Member Functions
	ZLogger (std::string filename, int logID)
	~ZLogger ()
bool	AddEntry (int category, std::string entry)

---

Constructor & Destructor Documentation

ZLogger::ZLogger (  std::string  filename, int  logID )

Constructor method. If the log file does not exist, then it is created with a header that contains a specific ID. If the full path is not included then the log file will be written to the active directory. If the file does indeed exist, with matching ID, then log entries will be appended. If the file exists, but is not a valid ZLogger file, or has a different ID, then a new log filename will be created with a unique numerical suffix. No fancy header parsing is implemented, so beware of tampering with the log file headers! Parameters: logID  Log file identifier. This identifier is written to the log file header for identification purposes. filename  The name of the log file. Returns: None. If the log file cannot be created or verified, then entries will not be logged.

ZLogger::~ZLogger (   )

Destructor Method. Returns: none

---

Member Function Documentation

bool ZLogger::AddEntry (  int  category, std::string  entry )

This method is called when a new entry is to be added to the log. This will only occur if LogActive has been set true. Any IO problems in this method will cause the LogActive flag to be set false, so that future logging will terminate. Parameters: category  Category of log entry (INFO, WARNING, ERROR). entry  The text log entry. Returns:

---

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

• include/OpenTracker/input/ZLogger.h
• src/input/ZLogger.cxx

---