Public Member Functions | |
BitStreamReader (byte[] _data) | |
Constructor creates a BitStreamReader object that retrieves data from a byte array in memory. | |
BitStreamReader (String _filename) | |
Constructor creates a BitStreamReader bbject that retrieves data from a file. If the file cannot be read, the method will throw a System.IO.FileNotFound exception. | |
byte | readByte (int _req_bits) |
Returns a byte value defined by the data contained in the number of bits given by the calling method. | |
char | readChar () |
Returns a char value. Will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store. | |
string | readString () |
Returns a string. The string is stored in a zero-terminated format. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store. | |
ushort | readUShort () |
Returns an unsigned short value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store. | |
short | readShort () |
Returns a short value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store. | |
int | readInt () |
Returns an integer value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store. | |
uint | readUInt () |
Returns an unsigned integer value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store. | |
long | readLong () |
Returns an long value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store. | |
ulong | readULong () |
Returns an unsigned long value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store. | |
float | readFloat () |
Returns a float value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store. | |
double | readDouble () |
Returns a double value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store. | |
void | close () |
Closes the BitStreamReader data storage and hence - access. |
UK_CO_MEVANSPN_libBitStream.BitStreamReader.BitStreamReader | ( | byte[] | _data | ) |
Constructor creates a BitStreamReader object that retrieves data from a byte array in memory.
_data | Reference to the data block to use. A System.Byte |
UK_CO_MEVANSPN_libBitStream.BitStreamReader.BitStreamReader | ( | String | _filename | ) |
Constructor creates a BitStreamReader bbject that retrieves data from a file. If the file cannot be read, the method will throw a System.IO.FileNotFound exception.
_filename | A string referencing the file holding the BitStreamReader data. A System.String |
byte UK_CO_MEVANSPN_libBitStream.BitStreamReader.readByte | ( | int | _req_bits | ) |
Returns a byte value defined by the data contained in the number of bits given by the calling method.
_req_bits | The number of bits to read from the BitStreamReader. Must be in the range 1 to 8. A System.Int32 |
char UK_CO_MEVANSPN_libBitStream.BitStreamReader.readChar | ( | ) |
Returns a char value. Will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store.
string UK_CO_MEVANSPN_libBitStream.BitStreamReader.readString | ( | ) |
Returns a string. The string is stored in a zero-terminated format. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store.
ushort UK_CO_MEVANSPN_libBitStream.BitStreamReader.readUShort | ( | ) |
Returns an unsigned short value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store.
short UK_CO_MEVANSPN_libBitStream.BitStreamReader.readShort | ( | ) |
Returns a short value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store.
int UK_CO_MEVANSPN_libBitStream.BitStreamReader.readInt | ( | ) |
Returns an integer value. The method will throw an EndOfDataException if there is insufficient data left in the BitStreamReader object's data store.
uint UK_CO_MEVANSPN_libBitStream.BitStreamReader.readUInt | ( | ) |
Returns an unsigned integer value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store.
long UK_CO_MEVANSPN_libBitStream.BitStreamReader.readLong | ( | ) |
Returns an long value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store.
ulong UK_CO_MEVANSPN_libBitStream.BitStreamReader.readULong | ( | ) |
Returns an unsigned long value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store.
float UK_CO_MEVANSPN_libBitStream.BitStreamReader.readFloat | ( | ) |
Returns a float value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store.
double UK_CO_MEVANSPN_libBitStream.BitStreamReader.readDouble | ( | ) |
Returns a double value. The method will throw an EndOfDataException if there is insufficient data left the BitStreamReader object's data store.
void UK_CO_MEVANSPN_libBitStream.BitStreamReader.close | ( | ) |
Closes the BitStreamReader data storage and hence - access.