iPE::Util::Output(3)

NAME
iPE::Util::Output - A class to aid in outputting parameter files for iParameterEstimation.

DESCRIPTION
Aids in keeping a standard output format for all parameter modules in iParameterEstimation through standard word and number formatting routines. Basic services are indentation, via indent, increaseIndent, and decreaseIndent. One can format floats with floatf and ints with intf. For tables with english words for, say, state names, one can use addWord and wordf to keep track of the maximum word length and format the word so as to keep a well flushed table.

FUNCTIONS

new(file_handle)
    Create and initialize a new Output object. Optionally pass a file handle to initialize the file handle associated with the output object.

fh ()
    Get the current filehandle from the output object.

setFH (file_handle)
    Sets the filehandle to the passed file handle.

indent ()
    Get the current indentation string.

tab ()
    Get a tab string.

setFileHandle (fileHandle)
    Sets the current file handle to output to.

print (scalar, ...)
    Print to the current file handle. Works just as Perl print does, except that it uses the contained file handle.

printPCdata (scalar)
    Print parsed character data. Use this to print out inputted data from XML files.

addWord (word_type, word)
    Add a new word to a given word_type. This keeps track of the maximum word length of a given word_type. For example, if you are printing out state names, you would add a number of state names, passing "State" to the word_type parameter. When the formatted words are retrieved via wordf, the tab indentation following the word would be consistent with the maximum word length of the "State" type, so that the words following appear in left-flushed columns.

wordf (word_type, word)
    Get the string for a word formatted of a certain type. If the words have not been added via addWord, this will just add a tab to the end of the word. No warning is thrown.

intf (value)
    Get the string for a formatted integer.

floatf (value)
    Get the string for a formatted floating point digit, with the set (or default, 10) number of digits after the decimal point.

increaseIndent ()
    Increases the current indent level for the output object. When indent is called, the length will increase the amount set by setIndentSize, or by the default, 4, if not called.

decreaseIndent ()
    Decreases the current indent level for the output object. When indent is called, the length will decrease the amount set by setIndentSize, or by the default, 4, if not called.

setIndentSize (size)
    Sets how many additional spaces are in a single indentation level.

setFloatSize (size)
    Sets how many precision decimal places to output with a floating point number.

reset ()
    Resets all the indentation flags and word length flags.

SEE ALSO
iPE

AUTHOR
Bob Zimmermann (rpz@cs.wustl.edu).

POD ERRORS
Hey! The above document had some coding errors, which are explained below:

Around line 228:
    You forgot a '=back' before '=head1'