Type Method

discreteProgress(totalUnitCount:)

Creates and returns an NSProgress instance with the specified totalUnitCount that is not part of any existing progress tree. The instance is initialized using init(parent:userInfo:) with the parent set to nil.

Declaration

class func discreteProgress(totalUnitCount unitCount: Int64) -> Progress

Parameters

unitCount

The total number of units of work to be carried out.

Discussion

Use this method to create the top level progress object returned by your own custom classes. The user of the returned progress object can add it to a progress tree using addChild(_:withPendingUnitCount:).

You are responsible for updating the progress count of the created progress object. You can invoke this method on one thread and then message the returned NSProgress on another thread. For example, you can capture the created progress instance in a block that you pass to dispatch_async(_:_:). In that block you can invoke methods like becomeCurrent(withPendingUnitCount:) or resignCurrent(), and set the completedUnitCount or isCancelled properties as work is carried out.

See Also

Creating Progress Objects

init(parent: Progress?, userInfo: [ProgressUserInfoKey : Any]?)

Initializes a newly allocated NSProgress instance.

init(totalUnitCount: Int64)

Creates and returns an NSProgress instance, initialized using init(parent:userInfo:).

init(totalUnitCount: Int64, parent: Progress, pendingUnitCount: Int64)

Creates and returns an NSProgress instance attached to the specified parent with the totalUnitCount set to portionOfParentTotalUnitCount.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software