documentation
project

EarthWalk
Software


EarthWalk
Software
is hosted by

SourceForge Logo


visit

Open Source Developers Network Logo

Version 1.0, April 20, 2002.

EWS::baseIO is an object-oriented basic input/output class. It provides redirectable access to console input and output, allows standard redirection, and provides a mechanism to allow output to be sent to the current console, a log file, or both.

EWS::baseIO was designed to be used as either a stand-alone object class, or as a base-class for other objects (such as EWS::htmlout). It supports full inheritence and all public methods and attributes were written to provide a straight-forward interface which may be safely overridden without harmful side effects.

EWS::baseIO provides the following class methods and attributes:

Class Methods
Public Methods Description
new Returns a blessed reference to a new baseIO object.
acceptMessage Accept input message.
Display Output message to current console.
DisplayAndAccept Display a message and wait for input.
DisplayAndPause Display message then wait for enter to be pressed.
DisplayDateString Returns a formated string consisting of the current date and time in the following format:

    hh:mm MM/DD/YYYY

DisplayLine Display the contents of message followed by newline. If timestamp is set, first output a string representing the current time.
DisplayLineAndAccept Display a message followed by newline, and wait for input complete.
DisplayLineAndPause Display message and new line, then wait for enter to be pressed.
DisplayMessage Output optional timestamp followed by message
GetDateString Returns a string consisting of the current date and time in the following format:

    YYYYMMDDhhmmss

newLine Output newline sequence.
Pause Wait for enter key of 'exit'.
timestampLine Output optional timestamp followed by message followed by newline.
timestampLineAndPause Included for backwards compatability. Refer to DisplayLineAndPause.
timestampMessage Output optional timestamp followed by message.
timestampMessageAndPause Included for backwards compatability. Refer to DisplayAndPause.
trimMessage trim message to the specified length.

Class Attributes
Public Attributes Description
htmlFormat Set/get the current htmlFormat setting.
Revision Returns the revision number of baseIO.pm
timestamp Set/get the current timestamp setting.
traceType Set/get the current trace type:

    0 = console
    1 = log file only
    2 = console and log file

Version Returns the version number.

EarthWalk Software. Copyright © 2002.