Class ErrorLogBuilder

This class is used to update the log display for the activity that occurs during processing of an event. It is not limited to the logging of error information but also records information about the event itself.

Build Information

Author Fred McGuirk
Date Nov 2, 2006
Outputfile ErrorLogBuilder.pvc
Forcelinenumbers false

Properties

PROPERTY bFalse

Boolean - False

PROPERTY bTrue

Boolean - True

PROPERTY eInfo

Static property - data written to log is for information purposes

PROPERTY eConsoleInfo

Static property - data written to log is to copied to console

PROPERTY eWarning

Static property - data written to log is a warning message

PROPERTY ECLEAR

Static property - ID of button that will trigger initialization of log window

PROPERTY ECONSOLE

Static property - ID of button to allow access to console mode in a development environment

PROPERTY ETEXT

Static property - ID of log window

PROPERTY eDebugLog$

Name of the log file

Methods

FUNCTION bufferAddText(initText$)

Add string to the current output buffer

ParameterDescription
initText$ Text to be added to the output buffer
FUNCTION bufferInit()

Initialize the output buffer; any information in the buffer will be destroyed.

FUNCTION bufferWriteText()

Write the contents of the buffer to the log window and clear the buffer.

FUNCTION setText(initText$)

Reset output buffer to the text provided.

ParameterDescription
initText$ Text to be placed into the output buffer.
FUNCTION setVisible(initBoolean)

Show / Hide the log window.

ParameterDescription
initBoolean A boolean flag to determine whether the log window is visible
FUNCTION update(aPvxState)

This class is primarily an observer that is invoked after an event to log information about the event and possibly information created by the event.

ParameterDescription
aPvxState A [ProvideX Class:pvxState] object reference.
FUNCTION write_log(LogText$, Severity)

** Internal Use **


Write the information in the output buffer to the log window (and file). This is used internally by other classes and the event manager; the alternate method bufferWriteText() should be used instead.

ParameterDescription
LogText$ The text to be written to the log window.
Severity A severity level to be assigned to the information written to the log window.

Methods inherited from: EventManagerObserver

getDescription$(), getEventNotificationFlag(), init(), update()