TABLE OF CONTENTS

• 1. moduleObj/openFile
• 2. moduleObj/readFile
• 3. moduleObj/readFileError
• 4. moduleObj/readFileWrongFormat
• 5. moduleObj/_openSyntaxError
• 6. moduleObj/_open

moduleObj/openFile

NAME

    ::guib::moduleObj::openFile -- open an input-file and calls readFile

USAGE

    openFile fileName

RETURN VALUE

    Returns opened filename.

EXAMPLE

    $moduleObj openFile myFile.inp

moduleObj/readFile

NAME

    ::guib::moduleObj::readFile -- reads and input-file

USAGE

    readFile fileChannel ?fileName?

DESCRIPTION

     This method reads the content of file-channel of a given input
 file. An example of the usage of the method is in ::guib::menuOpen
 proc, i.e., upon the user selection of an input file this method is
 called.

RETURN VALUE

    OK           -- input file is OK
    SYNTAX_ERROR -- input file contains syntax errors
    WRONG_FORMAT -- input file is not in appropriate format

EXAMPLE

    $moduleObj readFile $fID myFile.inp

moduleObj/readFileError

NAME

    ::guib::moduleObj::readFileError --  method for dealing with file-read errors

USAGE

    readFileError errMsg

DESCRIPTION

    When an error occurs while reading an input file, this method
 should be called to display an error and skip the reading of the
 input file. This method is supposed to be used from readfilter routines.
 

ARGUMENTS

     errMsg     -- error message to display when syntax error is encountered

moduleObj/readFileWrongFormat

NAME

    ::guib::moduleObj::readFileWrongFormat --  method for dealing with wrong-formatted input file

USAGE

    readFileWrongFormat formatName ?diagnosisText?

DESCRIPTION

 When an input-file is not in a proper format, this method should be
 called to display an appropriate error-message and skip the reading
 of the input file. This method is supposed to be used from
 readfilter routines.
 

ARGUMENTS

     formatName     -- name of the format (i.e. an arbitrary string)
     diagnosisText  -- a text containing a diagnose of the syntax errors [OPTIONAL]

moduleObj/_openSyntaxError

NAME

    ::guib::moduleObj::_open --  method for dealing with file-read errors

USAGE

    _openSyntaxError errMsg ?addSkipMsg?

DESCRIPTION

    When an error occurs while reading an input file, this method
 should be called to correctly handle the error. When a syntax error
 is encountered the reading should be skippe immediately, otherwise
 the GUI might trap in an infinite loop!!!
 

ARGUMENTS

     errMsg     -- error message to display when syntax error is encountered
     addSkipMsg -- do we add "Skipping the rest of the input file" text

moduleObj/_open

NAME

    ::guib::moduleObj::_open -- reads the content of file-channel of a given input-file recursively

USAGE

    _open keywordObj fileChannel

DESCRIPTION

    This method reads the content of file-channel of a given
 input-file recursively. Hence, it makes all the work for readFile
 method.

ARGUMENTS

    obj         -- the keywordObj object where the read content will be stored
    fileChannel -- file-channel of a given input file

RETURN VALUE

    None.

EXAMPLE

    _open $keywordObj $fID