FMIceLinkFileAssistant Class Reference

Inherits from NSObject
Declared in FMIceLinkFileAssistant.h
FMIceLinkFileAssistant.m

Overview

A utility class for reading/writing from/to a FMIceLinkFileAssistant#[file](#//api/name/file).

– file

Gets the file.
- (FMIceLinkFileStream *)file

Discussion

Gets the file.

Declared In

FMIceLinkFileAssistant.h

+ fileAssistantWithFile:

Initializes a new instance of the FMIceLinkFileAssistant class.
+ (FMIceLinkFileAssistant *)fileAssistantWithFile:(FMIceLinkFileStream *)file

Parameters

file

The file.

Discussion

Initializes a new instance of the FMIceLinkFileAssistant class.

Declared In

FMIceLinkFileAssistant.h

– initWithFile:

Initializes a new instance of the FMIceLinkFileAssistant class.
- (instancetype)initWithFile:(FMIceLinkFileStream *)file

Parameters

file

The file.

Discussion

Initializes a new instance of the FMIceLinkFileAssistant class.

Declared In

FMIceLinkFileAssistant.h

– littleEndian

Gets whether to read/write using little-endian ordering.
- (bool)littleEndian

Discussion

Gets whether to read/write using little-endian ordering.

Declared In

FMIceLinkFileAssistant.h

– read16

Converts a 16-bit network representation to an integer.
- (int)read16

Discussion

Converts a 16-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read24

Converts a 24-bit network representation to an integer.
- (int)read24

Discussion

Converts a 24-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read32

Converts a 32-bit network representation to an integer.
- (long long)read32

Discussion

Converts a 32-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read40

Converts a 40-bit network representation to an integer.
- (long long)read40

Discussion

Converts a 40-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read48

Converts a 48-bit network representation to an integer.
- (long long)read48

Discussion

Converts a 48-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read56

Converts a 56-bit network representation to an integer.
- (long long)read56

Discussion

Converts a 56-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read64

Converts a 64-bit network representation to an integer.
- (long long)read64

Discussion

Converts a 64-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

– read8

Converts an 8-bit network representation to an integer.
- (int)read8

Discussion

Converts an 8-bit network representation to an integer.

Declared In

FMIceLinkFileAssistant.h

+ readAllBytesWithPath:

Reads all the bytes of a [file](#//api/name/file) into a byte array.
+ (NSMutableData *)readAllBytesWithPath:(NSString *)path

Parameters

path

The filepath to the file to read.

Discussion

Reads all the bytes of a [file](#//api/name/file) into a byte array.

Declared In

FMIceLinkFileAssistant.h

– readOpaque16

Reads a 16-bit-length opaque value from a File.
- (NSMutableData *)readOpaque16

Discussion

Reads a 16-bit-length opaque value from a File.

Declared In

FMIceLinkFileAssistant.h

– readOpaque24

Reads a 24-bit-length opaque value from a File.
- (NSMutableData *)readOpaque24

Discussion

Reads a 24-bit-length opaque value from a File.

Declared In

FMIceLinkFileAssistant.h

– readOpaque32

Reads a 32-bit-length opaque value from a File.
- (NSMutableData *)readOpaque32

Discussion

Reads a 32-bit-length opaque value from a File.

Declared In

FMIceLinkFileAssistant.h

– readOpaque8

Reads an 8-bit-length opaque value from a File.
- (NSMutableData *)readOpaque8

Discussion

Reads an 8-bit-length opaque value from a File.

Declared In

FMIceLinkFileAssistant.h

– readWithLength:

Reads a value from a File.
- (NSMutableData *)readWithLength:(int)length

Parameters

length

The number of bytes to read.

Discussion

Reads a value from a File.

Declared In

FMIceLinkFileAssistant.h

– setLittleEndian:

Sets whether to read/write using little-endian ordering.
- (void)setLittleEndian:(bool)value

Discussion

Sets whether to read/write using little-endian ordering.

Declared In

FMIceLinkFileAssistant.h

– write:

Adds a value to a File.
- (void)write:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a value to a File.

Declared In

FMIceLinkFileAssistant.h

– write:offset:length:

Adds a value to a File.
- (void)write:(NSMutableData *)value offset:(int)offset length:(int)length

Parameters

value

The value.
offset

The offset.
length

The length.

Discussion

Adds a value to a File.

Declared In

FMIceLinkFileAssistant.h

– write16:

Adds a 16-bit value to a File.
- (void)write16:(int)value

Parameters

value

The value.

Discussion

Adds a 16-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write16ToWithLocation:value:

Adds a 16-bit value to a File.
- (void)write16ToWithLocation:(int)location value:(int)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 16-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write24:

Adds a 24-bit value to a File.
- (void)write24:(int)value

Parameters

value

The value.

Discussion

Adds a 24-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write24ToWithLocation:value:

Adds a 24-bit value to a File.
- (void)write24ToWithLocation:(int)location value:(int)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 24-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write32:

Adds a 32-bit value to a File.
- (void)write32:(long long)value

Parameters

value

The value.

Discussion

Adds a 32-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write32ToWithLocation:value:

Adds a 32-bit value to a File.
- (void)write32ToWithLocation:(int)location value:(long long)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 32-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write40:

Adds a 40-bit value to a File.
- (void)write40:(long long)value

Parameters

value

The value.

Discussion

Adds a 40-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write40ToWithLocation:value:

Adds a 40-bit value to a File.
- (void)write40ToWithLocation:(int)location value:(long long)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 40-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write48:

Adds a 48-bit value to a File.
- (void)write48:(long long)value

Parameters

value

The value.

Discussion

Adds a 48-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write48ToWithLocation:value:

Adds a 48-bit value to a File.
- (void)write48ToWithLocation:(int)location value:(long long)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 48-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write56:

Adds a 56-bit value to a File.
- (void)write56:(long long)value

Parameters

value

The value.

Discussion

Adds a 56-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write56ToWithLocation:value:

Adds a 56-bit value to a File.
- (void)write56ToWithLocation:(int)location value:(long long)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 56-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write64:

Adds a 64-bit value to a File.
- (void)write64:(long long)value

Parameters

value

The value.

Discussion

Adds a 64-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write64ToWithLocation:value:

Adds a 64-bit value to a File.
- (void)write64ToWithLocation:(int)location value:(long long)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 64-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write8:

Adds an 8-bit value to a File.
- (void)write8:(int)value

Parameters

value

The value.

Discussion

Adds an 8-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– write8ToWithLocation:value:

Adds an 8-bit value to a File.
- (void)write8ToWithLocation:(int)location value:(int)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds an 8-bit value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque16:

Adds a 16-bit-length opaque value to a File.
- (void)writeOpaque16:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 16-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque16ToWithLocation:value:

Adds a 16-bit-length opaque value to a File.
- (void)writeOpaque16ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 16-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque24:

Adds a 24-bit-length opaque value to a File.
- (void)writeOpaque24:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 24-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque24ToWithLocation:value:

Adds a 24-bit-length opaque value to a File.
- (void)writeOpaque24ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 24-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque32:

Adds a 32-bit-length opaque value to a File.
- (void)writeOpaque32:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 32-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque32ToWithLocation:value:

Adds a 32-bit-length opaque value to a File.
- (void)writeOpaque32ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 32-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque40:

Adds a 40-bit-length opaque value to a File.
- (void)writeOpaque40:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 40-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque40ToWithLocation:value:

Adds a 40-bit-length opaque value to a File.
- (void)writeOpaque40ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 40-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque48:

Adds a 48-bit-length opaque value to a File.
- (void)writeOpaque48:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 48-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque48ToWithLocation:value:

Adds a 48-bit-length opaque value to a File.
- (void)writeOpaque48ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 48-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque56:

Adds a 56-bit-length opaque value to a File.
- (void)writeOpaque56:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 56-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque56ToWithLocation:value:

Adds a 56-bit-length opaque value to a File.
- (void)writeOpaque56ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 56-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque64:

Adds a 64-bit-length opaque value to a File.
- (void)writeOpaque64:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds a 64-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque64ToWithLocation:value:

Adds a 64-bit-length opaque value to a File.
- (void)writeOpaque64ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a 64-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque8:

Adds an 8-bit-length opaque value to a File.
- (void)writeOpaque8:(NSMutableData *)value

Parameters

value

The value.

Discussion

Adds an 8-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeOpaque8ToWithLocation:value:

Adds an 8-bit-length opaque value to a File.
- (void)writeOpaque8ToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds an 8-bit-length opaque value to a File.

Declared In

FMIceLinkFileAssistant.h

– writeToWithLocation:value:

Adds a value to a File.
- (void)writeToWithLocation:(int)location value:(NSMutableData *)value

Parameters

location

The location to write to.
value

The value.

Discussion

Adds a value to a File.

Declared In

FMIceLinkFileAssistant.h