Deadline.Jobs.JobDependency Class Reference

Job Dependency class. More...

Inherits Deadline.Jobs.OffsetDependency.

Public Member Functions
virtual new object	Clone ()
	Clones this JobDependency and returns it. More...
virtual JobDependency	Copy ()
	Copies this JobDependency and returns it. More...
override bool	Equals (object obj)
	Override equals More...
	JobDependency ()
	Default constructor. More...
	JobDependency (string jobID)
	Overloaded constructor that allows the job id to be specified. More...
override string	ToString ()
	Returns the job ID. More...
Public Member Functions inherited from Deadline.Jobs.OffsetDependency
override bool	Equals (object obj)
	Override for equals More...
	OffsetDependency ()
	Default constructor. More...
	OffsetDependency (string notes, bool overrideFrameOffset, int startOffset, int endOffset, bool ignoreFrameOffset)
	Constructor. More...
Public Member Functions inherited from Deadline.Jobs.BaseDependency
	BaseDependency ()
	Default constructor. More...
	BaseDependency (string notes, bool ignoreFrameOffsets)
	Overloaded constructor that allows the notes and ignoreFrameOffsets to be specified. More...
override bool	Equals (object obj)
	Override for equals More...

Properties
string	JobID [get, set]
	The Job Id of the dependency. More...
bool	OverrideResumeOn [get, set]
	If enabled this job overrides the resume on settings. More...
bool	ResumeOnComplete [get, set]
	Enables resuming the dependent job when the Job Dependency completes. More...
bool	ResumeOnDeleted [get, set]
	Enables resuming the dependent job when the Job Dependency is deleted. More...
bool	ResumeOnFailed [get, set]
	Enables resuming the dependent job when the Job Dependency fails. More...
bool	ResumeOnPercentageCompleted [get, set]
	Enables resuming a Job after the dependency has completed to a certain percentage. More...
double	ResumeOnPercentageValue [get, set]
	The completion percentage value of the dependency that must be reached before the dependant job is resumed. More...
Properties inherited from Deadline.Jobs.OffsetDependency
int	EndOffset [get, set]
	The end offset for the dependency. More...
bool	OverrideFrameOffsets [get, set]
	Whether or not to override frame offsets for this dependency. More...
int	StartOffset [get, set]
	The start offset for the dependency. More...
Properties inherited from Deadline.Jobs.BaseDependency
bool	IgnoreFrameOffsets [get, set]
	Whether or not to ignore frame offsets. More...
string	Notes [get, set]
	Notes for the dependency. More...

Detailed Description

Job Dependency class.

Constructor & Destructor Documentation

JobDependency() [1/2]

Deadline.Jobs.JobDependency.JobDependency

(

)

Default constructor.

JobDependency() [2/2]

Deadline.Jobs.JobDependency.JobDependency

(

string

jobID

)

Overloaded constructor that allows the job id to be specified.

Parameters

jobID

Member Function Documentation

Clone()

virtual new object Deadline.Jobs.JobDependency.Clone ( )

virtual

Clones this JobDependency and returns it.

Returns

A clone of this JobDependency.

Reimplemented from Deadline.Jobs.OffsetDependency.

Copy()

virtual JobDependency Deadline.Jobs.JobDependency.Copy ( )

virtual

Copies this JobDependency and returns it.

Returns

A copy of this JobDependency.

Equals()

override bool Deadline.Jobs.JobDependency.Equals

(

object

obj

)

Override equals

Parameters

obj

Returns

ToString()

override string Deadline.Jobs.JobDependency.ToString

(

)

Returns the job ID.

Returns

The job ID as a string.

Property Documentation

JobID

string Deadline.Jobs.JobDependency.JobID

getset

The Job Id of the dependency.

OverrideResumeOn

bool Deadline.Jobs.JobDependency.OverrideResumeOn

getset

If enabled this job overrides the resume on settings.

ResumeOnComplete

bool Deadline.Jobs.JobDependency.ResumeOnComplete

getset

Enables resuming the dependent job when the Job Dependency completes.

ResumeOnDeleted

bool Deadline.Jobs.JobDependency.ResumeOnDeleted

getset

Enables resuming the dependent job when the Job Dependency is deleted.

ResumeOnFailed

bool Deadline.Jobs.JobDependency.ResumeOnFailed

getset

Enables resuming the dependent job when the Job Dependency fails.

ResumeOnPercentageCompleted

bool Deadline.Jobs.JobDependency.ResumeOnPercentageCompleted

getset

Enables resuming a Job after the dependency has completed to a certain percentage.

ResumeOnPercentageValue

double Deadline.Jobs.JobDependency.ResumeOnPercentageValue

getset

The completion percentage value of the dependency that must be reached before the dependant job is resumed.