5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface Block extends FrameworkInterface {
26 * Reads the file header
30 function readFileHeader ();
33 * Flushes the file header
37 function flushFileHeader ();
40 * Close a file source and set it's instance to null and the file name
44 * @throws NullPointerException If the file pointer instance is not set by setPointer()
45 * @throws InvalidResourceException If there is being set
47 function closeFile ();
50 * Determines whether the EOF has been reached
52 * @return $isEndOfFileReached Whether the EOF has been reached
54 function isEndOfFileReached ();
57 * Getter for file name
59 * @return $fileName The current file name
61 function getFileName ();
64 * Initializes counter for valid entries, arrays for damaged entries and
65 * an array for gap seek positions. If you call this method on your own,
66 * please re-analyze the file structure. So you are better to call
67 * analyzeFile() instead of this method.
71 function initCountersGapsArray ();
74 * Getter for header size
76 * @return $totalEntries Size of file header
78 function getHeaderSize ();
81 * Setter for header size
83 * @param $headerSize Size of file header
86 function setHeaderSize ($headerSize);
89 * Getter for header array
91 * @return $totalEntries Size of file header
93 function getHeader ();
98 * @param $header Array for a file header
101 function setHeader (array $header);
104 * Updates seekPosition attribute from file to avoid to much access on file.
108 function updateSeekPosition ();
111 * Getter for total entries
113 * @return $totalEntries Total entries in this file
115 function getCounter ();