Log Class Reference

Special class for logging all data to the command prompt, JTextAreas in a GUI, and a chosen plain-text log file. More...

List of all members.

Static Public Member Functions
static void	close () throws IOException
	Free all system resources currently held by Log.
static void	out (Quantizer source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (GestureModel source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (Classifier source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (Filter source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (Frog source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (Session source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	out (Device source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static synchronized void	out (Object source, String message)
	Attempts to log data to the text file and/or the JTextArea associated with this Log.
static void	setLogFile (File file) throws IOException
	Attempts to create and then write to the file specified.
static void	addTextArea (JTextArea txtArea)
	Gives the Log a JTextArea to append messages to.
static String	getTimestamp ()
	The current time as a String for the file writes.
static void	resetConsoles ()
	Resets all JTextAreas associated with this log to be completely empty.
Static Public Attributes
static boolean	logModel = true
	Specifies whether to log any out requests from an GestureModel object.
static boolean	logClassifier = true
	Specifies whether to log any out requests from a Classifier object.
static boolean	logQuantizer = true
	Specifies whether to log any out requests from a Quantizer object.
static boolean	logFilters = true
	Specifies whether to log any out requests from a Filter object.
static boolean	logDevices = true
	Specifies whether to log any out requests from a Device object.
static boolean	logFROG = true
	Specifies whether to log any out requests from the FROG class.
static boolean	logSession = true
	Specifies whether to log any out requests from the Session class.
static boolean	logSystemOut = true
	Specifies whether messages should be logged to System.out.println.
static boolean	logXYZ = true
	Specifies whether the raw accelerations going through Devices should be logged.

---

Detailed Description

Special class for logging all data to the command prompt, JTextAreas in a GUI, and a chosen plain-text log file.

Author:

Team Better Recognize

---

Member Function Documentation

static void addTextArea

(

JTextArea

txtArea

)

[static]

Gives the Log a JTextArea to append messages to.

Parameters:

txtArea

text area in your GUI that you want log messages sent to

static void close

(

)

throws IOException [static]

Free all system resources currently held by Log.

Here is the call graph for this function:

static String getTimestamp

(

)

[static]

The current time as a String for the file writes.

Returns:

a short version of the current time

Here is the caller graph for this function:

static synchronized void out	(	Object	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

Parameters:

	source	the object calling this method
	message	the message to show the user

Here is the call graph for this function:

static void out	(	Device	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logDevices boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Device object calling this method
	message	the message to show the user

static void out	(	Session	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logFROG boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Filter object calling this method
	message	the message to show the user

static void out	(	Frog	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logFROG boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Filter object calling this method
	message	the message to show the user

static void out	(	Filter	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logFilter boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Filter object calling this method
	message	the message to show the user

static void out	(	Classifier	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logClassifier boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Classifier object calling this method
	message	the message to show the user

static void out	(	GestureModel	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logModel boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the GestureModel object calling this method
	message	the message to show the user

static void out	(	Quantizer	source,
		String	message
	)			[static]

Attempts to log data to the text file and/or the JTextArea associated with this Log.

This is subject to the logModel boolean being true to prevent any unwanted Log entries.

Parameters:

	source	the Quantizer object calling this method
	message	the message to show the user

static void resetConsoles

(

)

[static]

Resets all JTextAreas associated with this log to be completely empty.

Here is the caller graph for this function:

static void setLogFile

(

File

file

)

throws IOException [static]

Attempts to create and then write to the file specified.

Subsequent calls to "out(...)" will perform write operations on this file. If a file was already specified, that file is closed and a new writer created.

Parameters:

file

the file to write log data to

Exceptions:

IOException

If the file cannot be created or written to

---

Member Data Documentation

boolean logClassifier = true [static]

Specifies whether to log any out requests from a Classifier object.

boolean logDevices = true [static]

Specifies whether to log any out requests from a Device object.

boolean logFilters = true [static]

Specifies whether to log any out requests from a Filter object.

boolean logFROG = true [static]

Specifies whether to log any out requests from the FROG class.

boolean logModel = true [static]

Specifies whether to log any out requests from an GestureModel object.

boolean logQuantizer = true [static]

Specifies whether to log any out requests from a Quantizer object.

boolean logSession = true [static]

Specifies whether to log any out requests from the Session class.

boolean logSystemOut = true [static]

Specifies whether messages should be logged to System.out.println.

boolean logXYZ = true [static]

Specifies whether the raw accelerations going through Devices should be logged.

---

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

• /Users/dev/Documents/SVN brazos.cs.tcu.edu/trunk/FROG/src/frog/Log.java