DRErase

Overview

A DRErase object handles the process of erasing a rewritable CD or DVD disc.

Discussion

Each time you want to erase a disc, an instance of this class needs to be created.

When an instance is created, you pass in an instance of DRDevice to let the object know what device to erase. This object is retained for the life of the DRErase instance.

A DRErase object will send out notifications through the DRNotificationCenter mechanism to broadcast the erase state to any interested observers. However, if for some reason you don't want to use notifications, you can poll the erase object at any time for the current status using status . This is not recommended in any application using a run loop, because it involves polling.

Here's an example that shows you how to use this class:

- (void) doErase
{
DRDevice* device;
DRErase* erase;


...determine correct device to erase...


erase = [[DRErase alloc] initWithDevice:device];


// we'll do a quick erase. It's typically all that's needed.
[erase setEraseType:DREraseTypeQuick];


// register to receive notification about the erase status.
[[DRNotificationCenter currentRunLoopCenter] addObserver:self
selector:@selector(eraseNotification:)
name:DREraseStatusChangedNotification
object:erase];


// start the erase
[erase start];
}

- (void) eraseNotification:(NSNotification*)notification
{
DRErase* erase = [notification object];
NSDictionary* status = [notification userInfo];


...do what you wish with the notification...
}

Methods

-device

Returns the device being used for the erase.

+eraseForDevice:

Creates and returns an erase object.

-initWithDevice:

Initializes an erase object.

-properties

Returns the properties dictionary of the erase.

-setProperties:

Sets the properties dictionary of the erase

-start

Begin the process of erasing media.

-status

Returns a dictionary containing the status of the erase.

Returns the device being used for the erase.

- (DRDevice*) device; 

Return Value

The DRDevice the erase will use.

Creates and returns an erase object.

+ (DRErase*) eraseForDevice:(DRDevice*)device; 

Parameters

device

Device to use for the erase.

Return Value

An autoreleased DRErase object.

Discussion

An erase object created with this method is ready to erase media.

Initializes an erase object.

- (id) initWithDevice:(DRDevice*)device; 

Parameters

device

Device to use for the erase.

Return Value

A DRErase object.

Discussion

An erase object created with this method is ready to erase media.

Returns the properties dictionary of the erase.

- (NSDictionary*) properties; 

Return Value

An NSDictionary containing the properties of the erase.

Sets the properties dictionary of the erase

- (void) setProperties:(NSDictionary*)properties; 

Parameters

properties

NSDictionary of the properties to set.

Begin the process of erasing media.

- (void) start; 

Discussion

This method only kicks off the erase. Once the erasure starts, control returns to the caller. The caller can monitor the progress of the erase by listening for a notification or by polling status .

Returns a dictionary containing the status of the erase.

- (NSDictionary*) status; 

Return Value

An NSDictionary containing the status of the erase.

Discussion

The same dictionary is returned through the DREraseStatusChangedNotification notification.

Did this document help you? Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.

Last Updated: 2008-04-01