5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 * Determines whether the EOF has been reached
42 * @return $isEndOfFileReached Whether the EOF has been reached
44 function isEndOfFileReached ();
47 * Getter for file name
49 * @return $fileName The current file name
51 function getFileName ();
54 * Initializes counter for valid entries, arrays for damaged entries and
55 * an array for gap seek positions. If you call this method on your own,
56 * please re-analyze the file structure. So you are better to call
57 * analyzeFile() instead of this method.
61 function initCountersGapsArray ();
64 * Getter for header size
66 * @return $totalEntries Size of file header
68 function getHeaderSize ();
71 * Setter for header size
73 * @param $headerSize Size of file header
76 function setHeaderSize ($headerSize);
79 * Getter for header array
81 * @return $totalEntries Size of file header
83 function getHeader ();
88 * @param $header Array for a file header
91 function setHeader (array $header);
94 * Updates seekPosition attribute from file to avoid to much access on file.
98 function updateSeekPosition ();
101 * Getter for total entries
103 * @return $totalEntries Total entries in this file
105 function getCounter ();
108 * "Getter" for file size
110 * @return $fileSize Size of currently loaded file
112 function getFileSize ();
115 * Writes given value to the file and returns a hash and gap position for it
117 * @param $groupId Group identifier
118 * @param $value Value to be added to the stack
119 * @return $data Hash and gap position
121 function writeValueToFile ($groupId, $rawData);
124 * Writes given raw data to the file and returns a gap position and length
126 * @param $groupId Group identifier
127 * @param $hash Hash from encoded value
128 * @param $encoded Encoded value to be written to the file
129 * @return $data Gap position and length of the raw data
131 function writeDataToFreeGap ($groupId, $hash, $encoded);
134 * Writes data at given position
136 * @param $seekPosition Seek position
137 * @param $data Data to be written
138 * @param $flushHeader Whether to flush the header (default: flush)
141 function writeData ($seekPosition, $data, $flushHeader = TRUE);
144 * Searches for next suitable gap the given length of data can fit in
145 * including padding bytes.
147 * @param $length Length of raw data
148 * @return $seekPosition Found next gap's seek position
150 function searchNextGap ($length);