diff options
author | Mike Buland <eichlan@xagasoft.com> | 2009-08-09 05:30:34 +0000 |
---|---|---|
committer | Mike Buland <eichlan@xagasoft.com> | 2009-08-09 05:30:34 +0000 |
commit | 4e86c50016ecfea40a72930cdd0460143f9edf4a (patch) | |
tree | e13c153b8042752a64134b3565e0e87a61d51398 /src/bitstring.h | |
parent | 9e48c6f7d602364eb1c18de7e1e4c00e4852839c (diff) | |
download | libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.gz libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.bz2 libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.tar.xz libbu++-4e86c50016ecfea40a72930cdd0460143f9edf4a.zip |
Really, just a lot of documenting.
Diffstat (limited to '')
-rw-r--r-- | src/bitstring.h | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/src/bitstring.h b/src/bitstring.h index 35f854f..b5f1ada 100644 --- a/src/bitstring.h +++ b/src/bitstring.h | |||
@@ -202,57 +202,6 @@ namespace Bu | |||
202 | */ | 202 | */ |
203 | long toLong( long iStart = 0, long iSize = 32 ); | 203 | long toLong( long iStart = 0, long iSize = 32 ); |
204 | 204 | ||
205 | /** | ||
206 | * Converts the data into a human-readable SString object. SString is | ||
207 | * used to make transport of the string and management very simple. | ||
208 | * Since BitStrings will generally be longer than your average strip of | ||
209 | * ints a faculty is included and turned on by default that will insert | ||
210 | * spacers into the output text every 8 places. For debugging work, | ||
211 | * this is definately reccomended. | ||
212 | *@param bAddSpacers Leave set to true in order to have the output | ||
213 | * broken into logical groupings of 8 bits per block. Set to off to | ||
214 | * have a harder | ||
215 | * to read solid block of bits. | ||
216 | *@returns A SString object containing the produced string. | ||
217 | */ | ||
218 | //std::string toString( bool bAddSpacers = true ); | ||
219 | |||
220 | // Utility | ||
221 | /** | ||
222 | * Converts the given number of bits into the smallest allocatable unit, | ||
223 | * which is bytes in C and on most systems nowadays. This is the | ||
224 | * minimum number of bytes needed to contain the given number of bits, | ||
225 | * so there is generally some slop if they are not evenly divisible. | ||
226 | *@param iBits The number of bits you wish to use. | ||
227 | *@returns The number of bytes you will need to contain the given number | ||
228 | * of bits. | ||
229 | */ | ||
230 | //static long bitsToBytes( long iBits ); | ||
231 | |||
232 | /** | ||
233 | * Writes all data in the BitString, including a small header block | ||
234 | * describing the number of bits in the BitString to the file described | ||
235 | * by the given file descriptor. The data writen is purely sequential | ||
236 | * and probably not too easy to read by other mechanisms, although the | ||
237 | * readFromFile function should always be able to do it. This function | ||
238 | * does not open nor close the file pointed to by fh. | ||
239 | *@param fh The file descriptor of the file to write the data to. | ||
240 | *@returns true if the operation completed without error, false | ||
241 | * otherwise. | ||
242 | */ | ||
243 | //bool writeToFile( FILE *fh ); | ||
244 | |||
245 | /** | ||
246 | * Reads data formatted by writeToFile and clears out any data that may | ||
247 | * have been in the BitString. This function preserves nothing in the | ||
248 | * original BitString that it may be replacing. This function does not | ||
249 | * open nor close the file pointed to by fh. | ||
250 | *@param fh The file descriptor to try to read the data from. | ||
251 | *@returns true if the operation completed without error, false | ||
252 | * otherwise. | ||
253 | */ | ||
254 | //bool readFromFile( FILE *fh ); | ||
255 | |||
256 | //operators | 205 | //operators |
257 | BitString &operator=( const BitString &xSrc ); | 206 | BitString &operator=( const BitString &xSrc ); |
258 | BitString operator~(); | 207 | BitString operator~(); |