XGJob

Inherits from:
Declared In:

Overview

This class provides a local interface to remote Xgrid jobs.



Methods

-activeCPUPower

Returns the active CPU power of the job.

-applicationIdentifier

Returns the applicationIdentifier of the job.

-applicationInfo

Returns the applicationInfo of the job.

-completedTaskCount

Returns the number of tasks that have completed.

-dateStarted

Returns the date the job was started.

-dateStopped

Returns the date the job was stopped.

-dateSubmitted

Returns the date the job was submitted.

-name

Returns the name associated with the job.

-percentDone

Returns the percentage of the job that has completed.

-performDeleteAction

Attempts to delete the job represented by the receiver.

-performGetOutputFilesAction

Attempts to retrieve a list of output files for the job represented by the receiver.

-performGetOutputStreamsAction

Attempts to retrieve a list of output streams for the job represented by the receiver.

-performGetSpecificationAction

Attempts to retrieve the specification used to submit the job represented by the reciever.

-performRestartAction

Attempts to restart the job represented by the receiver.

-performResumeAction

Attempts to resume the job represented by the receiver.

-performStopAction

Attempts to stop the job represented by the receiver.

-performSuspendAction

Attempts to suspend the job represented by the receiver.

-taskCount

Returns the number of tasks that make up the job.


activeCPUPower


Returns the active CPU power of the job.

- (float)activeCPUPower ; 
Return Value

The active CPU power of the job.

Discussion

The active CPU power of a job is the sum of the CPU power of each of the active processors running one of the job's tasks.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

applicationIdentifier


Returns the applicationIdentifier of the job.

- (NSString *)applicationIdentifier ; 
Return Value

The applicationIdentifier of the job.

Discussion

The applicationIdentifier is a identifier string set on the job by the application that submitted the job. The appliationIdentifier is not guaranteed to be unique.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

applicationInfo


Returns the applicationInfo of the job.

- (NSDictionary *)applicationInfo ; 
Return Value

The applicationInfo of the job.

Discussion

The applicationInfo is a dictionary set on the job by the application that submitted the job.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

completedTaskCount


Returns the number of tasks that have completed.

- (NSInteger)completedTaskCount ; 
Return Value

The number of completed tasks.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

dateStarted


Returns the date the job was started.

- (NSDate *)dateStarted ; 
Return Value

The start date.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

dateStopped


Returns the date the job was stopped.

- (NSDate *)dateStopped ; 
Return Value

The stop date.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

dateSubmitted


Returns the date the job was submitted.

- (NSDate *)dateSubmitted ; 
Return Value

The submission date.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

name


Returns the name associated with the job.

- (NSString *)name ; 
Return Value

A string.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

percentDone


Returns the percentage of the job that has completed.

- (float)percentDone ; 
Return Value

The percent done, from 0.0 to 100.0.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performDeleteAction


Attempts to delete the job represented by the receiver.

- (XGActionMonitor *)performDeleteAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performGetOutputFilesAction


Attempts to retrieve a list of output files for the job represented by the receiver.

- (XGActionMonitor *)performGetOutputFilesAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performGetOutputStreamsAction


Attempts to retrieve a list of output streams for the job represented by the receiver.

- (XGActionMonitor *)performGetOutputStreamsAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performGetSpecificationAction


Attempts to retrieve the specification used to submit the job represented by the reciever.

- (XGActionMonitor *)performGetSpecificationAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performRestartAction


Attempts to restart the job represented by the receiver.

- (XGActionMonitor *)performRestartAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performResumeAction


Attempts to resume the job represented by the receiver.

- (XGActionMonitor *)performResumeAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performStopAction


Attempts to stop the job represented by the receiver.

- (XGActionMonitor *)performStopAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

performSuspendAction


Attempts to suspend the job represented by the receiver.

- (XGActionMonitor *)performSuspendAction ; 
Return Value

An XGActionMonitor instance for tracking the action progress.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

taskCount


Returns the number of tasks that make up the job.

- (NSInteger)taskCount ; 
Return Value

The number of tasks.

Availability
Introduced in OS X v10.4, but later deprecated in OS X v10.7. Not available in iOS.

 

Did this document help you? Yes It's good, but... Not helpful...