ScannerSettingsLoader Class Reference

#import <ScannerSettingsLoader.h>

Inheritance diagram for ScannerSettingsLoader:

Instance Methods
(instancetype _Nullable)	- initWithError:
(BOOL)	- registerScanner:withError:
(BOOL)	- unregisterScanner:withError:
(BOOL)	- isScanner:registered:withError:
(BOOL)	- registerScannerExecutor:withError:
(BOOL)	- unregisterScannerExecutor:withError:
(BOOL)	- isScannerExecutor:registered:withError:
Instance Methods inherited from SettingsLoader
(BOOL)	- loadSettingsFromFileAtPath:withError:
(BOOL)	- loadSettingsFromString:withError:

Detailed Description

ScannerSettingsLoader class provides the means to load your settings into your scanners or scanner executors to prepare for scanning.

Method Documentation

initWithError:()

- (instancetype _Nullable) initWithError:

(NSError *_Nullable *_Nullable)

error

Initializes a new object immediately after memory for it has been allocated

Note

The designated initializer

Parameters

error

The error representing the reason for the failure

Returns

The initialized object

isScanner:registered:withError:()

- (BOOL) isScanner:		(Scanner *_Nonnull)	scanner
registered:		(BOOL *_Nonnull)	isRegistered
withError:		(NSError *_Nullable *_Nullable)	error

Checks if a scanner is already registred with this settings loader

Parameters

scanner	The scanner that needs to be checked if already registered
isRegistered	Will be set to the registered status in case the check was successful
error	The error representing the reason for the check failure

Returns

True if check was successful, false in case an error occured

isScannerExecutor:registered:withError:()

- (BOOL) isScannerExecutor:		(ScannerExecutor *_Nonnull)	scannerExecutor
registered:		(BOOL *_Nonnull)	isRegistered
withError:		(NSError *_Nullable *_Nullable)	error

Checks if a scanner executor is already registred with this settings loader

Parameters

scannerExecutor	The scanner executor that needs to be checked if already registered
isRegistered	Will be set to the registered status in case the check was successful
error	The error representing the reason for the check failure

Returns

True if check was successful, false in case an error occured

registerScanner:withError:()

- (BOOL) registerScanner:		(Scanner *_Nonnull)	scanner
withError:		(NSError *_Nullable *_Nullable)	error

Registers a scanner with this settings loader. If any settings were previously loaded, they will be propagated to the new registered scanner.

Note

Always unregister scanner from settings loader before destroying a scanner.

Precondition

scanner is not registered

Parameters

scanner	The scanner that needs to be registered
error	The error representing the reason for the registration failure

Returns

True if registration was successful, false in case an error occured

registerScannerExecutor:withError:()

- (BOOL) registerScannerExecutor:		(ScannerExecutor *_Nonnull)	scannerExecutor
withError:		(NSError *_Nullable *_Nullable)	error

Registers a scanner executor with this settings loader. If any settings were previously loaded, they will be propagated to the new registered scanner executor.

Note

Always unregister scanner executor from settings loader before destroying a scanner executor.

Precondition

scannerExecutor is not registered

Parameters

scannerExecutor	The scanner executor that needs to be registered
error	The error representing the reason for the registration failure

Returns

True if registration was successful, false in case an error occured

unregisterScanner:withError:()

- (BOOL) unregisterScanner:		(Scanner *_Nonnull)	scanner
withError:		(NSError *_Nullable *_Nullable)	error

Unregisters a scanner from this settings loader

Precondition

scanner is registered

Parameters

scanner	The scanner that needs to be unregistered
error	The error representing the reason for the unregister failure

Returns

True if unregister was successful, false in case an error occured

unregisterScannerExecutor:withError:()

- (BOOL) unregisterScannerExecutor:		(ScannerExecutor *_Nonnull)	scannerExecutor
withError:		(NSError *_Nullable *_Nullable)	error

Unregisters a scanner executor from this settings loader

Precondition

scannerExecutor is registered

Parameters

scannerExecutor	The scanner executor that needs to be unregistered
error	The error representing the reason for the unregister failure

Returns

True if unregister was successful, false in case an error occured

---

The documentation for this class was generated from the following file:

• ScannerSettingsLoader.h