usbdmx.com Home of the opto isolated, bus powered, DMX512 interface with both in and out universes. Cheap and simple to build. USBDMX logo

NSObject(LOFileManagerDelegate) Class Reference

Delegate interface to customise the behaviour of the LOFileManager. More...

#import <LOFileManager.h>


Public Member Functions

(BOOL) - shouldOverwriteChannelManagerFileAtPath:
 Check to see if we may overwrite a Channel Manager file.
(BOOL) - shouldOverwriteShowFileAtPath:
 Check to see if we may overwrite a show file.
(BOOL) - shouldOverwriteFileAtPath:
 Check to see if we may overwrite a file.
(void) - willWriteShowFileAtPath:withXML:
 Called when just before the show file is written.
(void) - didWriteShowFileAtPath:withXML:
 Called just after the show file has been writen.
(void) - writingFileAtPath:hadError:
 Called when there is a write file errror.
(void) - willLoadChannelManagerFrom:withXML:
 Called before the channel manager cofniguration is loaded from a file.
(void) - willLoadSceneManagerFrom:withXML:
 Called before the scene manager is loaded from a file.
(void) - willLoadCueManagerFrom:withXML:
 Called before the cue manager is loaded from a file.
(void) - willLoadChaseManagerFrom:withXML:
 Called before the chase manager is loaded from a file.
(void) - readingFileAtPath:hadError:
 Called when there is a read file errror.
(NSString *) - replaceHWBridge:
 Called when loading a channel manager file if the required brige is not currently plugged into the system.
(void) - didLoadShowFileAtPath:withXML:
 Called when just after the show file has been loaded.


Detailed Description

Delegate interface to customise the behaviour of the LOFileManager.

Member Function Documentation

- (void) didLoadShowFileAtPath: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called when just after the show file has been loaded.

This gives the opportunity to use the modifications made in willWriteShowFileAtPath:withXML

- (NSString *) replaceHWBridge: (NSString *)  serial  

Called when loading a channel manager file if the required brige is not currently plugged into the system.

This method responds with the bridge to use.

Parameters:
serial The serial number of the missing bridge
Returns:
A serial number of a bridge to use, or nil for a dummy

- (BOOL) shouldOverwriteChannelManagerFileAtPath: (NSString *)  thePath  

Check to see if we may overwrite a Channel Manager file.

This delegate method is called before a Channel Manager file is overwritten. If this method returns NO the file will not be overwritten, and the saveChannelManagerAtPath method will return NO.

Returns:
YES to allow the file to be overwritten
See also:
- shouldOverwriteFileAtPath:

- (BOOL) shouldOverwriteFileAtPath: (NSString *)  thePath  

Check to see if we may overwrite a file.

This method is only called if the specific one does not exist

This delegate method is called before a file is overwritten. If this method returns NO the file will not be overwritten, and the save file method will return NO.

Returns:
YES to allow the file to be overwritten
See also:
- shouldOverwriteChannelManagerFileAtPath:

- shouldOverwriteShowFileAtPath:

- (BOOL) shouldOverwriteShowFileAtPath: (NSString *)  thePath  

Check to see if we may overwrite a show file.

This delegate method is called before a show file is overwritten. If this method returns NO the file will not be overwritten, and the saveShowAtPath method will return NO.

Returns:
YES to allow the file to be overwritten
See also:
- shouldOverwriteFileAtPath:

- (void) willLoadChannelManagerFrom: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called before the channel manager cofniguration is loaded from a file.

- (void) willLoadChaseManagerFrom: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called before the chase manager is loaded from a file.

- (void) willLoadCueManagerFrom: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called before the cue manager is loaded from a file.

- (void) willLoadSceneManagerFrom: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called before the scene manager is loaded from a file.

- (void) willWriteShowFileAtPath: (NSString *)  thePath
withXML: (NSXMLElement *)  showXML 

Called when just before the show file is written.

This gives the opportunity to add / modify the XML before it is written out.

- (void) writingFileAtPath: (NSString *)  thePath
hadError: (NSError *)  theError 

Called when there is a write file errror.

This method is NOT called if the error is produced by a delegate not allowing the write to happen


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