Class JobDescription

Collects all information for a deconvolution Job to be created.

Description of the job to be processed by HuCore Consisting of owner information, a parameter setting, a task setting and a list of image files.

Namespace: hrm\job
Package: hrm
Located at job/JobDescription.php

Methods summary

`public`	# `__construct( )` JobDescription constructor. JobDescription constructor.
`public string`	# `message( )` Returns last error message. Returns last error message. Returns string Last error message.
`public string`	# `id( )` Returns the unique id that identifies the Job. Returns the unique id that identifies the Job. Returns string Unique id.
`public`	# `setId( string $id )` Sets the (unique) id of the Job. Sets the (unique) id of the Job. Parameters `$id` Unique id.
`public string`	# `gpu( )` Returns the GPU ID of the card where to run the Job. Returns the GPU ID of the card where to run the Job. Returns string $gpuId.
`public`	# `setGpu( string $gpuId )` Sets the GPU ID of the card where the Job runs. Sets the GPU ID of the card where the Job runs. Parameters `$gpuId`
`public hrm\user\UserV2`	# `owner( )` Returns the User owner of the job. Returns the User owner of the job. Returns `hrm\user\UserV2` Owner of the job.
`public`	# `setOwner( hrm\user\UserV2 $owner )` Sets the owner of the Job Sets the owner of the Job Parameters `$owner` Owner of the Job
`public hrm\setting\ParameterSetting`	# `parameterSetting( )` Returns the ParameterSetting associated with the job. Returns the ParameterSetting associated with the job. Returns `hrm\setting\ParameterSetting` A ParameterSetting object.
`public hrm\setting\TaskSetting`	# `taskSetting( )` Returns the TaskSetting associated with the job. Returns the TaskSetting associated with the job. Returns `hrm\setting\TaskSetting` A TaskSetting object.
`public hrm\setting\AnalysisSetting`	# `analysisSetting( )` Returns the AnalysisSetting associated with the job. Returns the AnalysisSetting associated with the job. Returns `hrm\setting\AnalysisSetting` An AnalysisSetting object.
`public array`	# `files( )` Returns the files associated with the job. Returns the files associated with the job. Returns array Array of file names.
`public boolean`	# `autoseries( )` Returns the automatically load series mode of the job. Returns the automatically load series mode of the job. Returns boolean True if series should be loaded automatically, false otherwise.
`public`	# `setParameterSetting( hrm\setting\ParameterSetting $setting )` Sets the ParameterSetting for the job Sets the ParameterSetting for the job Parameters `$setting` A ParameterSetting object.
`public`	# `setTaskSetting( hrm\setting\TaskSetting $setting )` Sets the TaskSetting for the job. Sets the TaskSetting for the job. Parameters `$setting` A TaskSetting object.
`public`	# `setAnalysisSetting( hrm\setting\AnalysisSetting $setting )` Sets the AnalysisSetting for the job. Sets the AnalysisSetting for the job. Parameters `$setting` An AnalysisSetting object.
`public`	# `setFiles( array $files, boolean $autoseries = FALSE )` Sets the list of files for the job. Sets the list of files for the job. Parameters `$files` Array of file names. `$autoseries` True if the file series should be loaded automatically, false otherwise.
`public string`	# `group( )` Returns the group of the user associated with the job. Returns the group of the user associated with the job. Returns string Group of the user.
`public`	# `setGroup( string $group )` Sets the group of the user associated with the job. Sets the group of the user associated with the job. Parameters `$group` Group of the user.
`public string`	# `getHuTemplateName( )` Returns the Huygens template name containing the unique HRM id. Returns the Huygens template name containing the unique HRM id. Returns string The template name.
`public boolean`	# `addJob( )` Add a Job to the queue Add a Job to the queue Returns boolean True if the Job could be added to the queue, false otherwise.
`public boolean`	# `createJob( )` Create a Job from this JobDescription. Create a Job from this JobDescription. Returns boolean True if the Job could be created, false otherwise.
`public`	# `processCompoundJobs( )` Processes compound Jobs to deliver elementary Jobs. Processes compound Jobs to deliver elementary Jobs. A compound job contains multiple files.
`public`	# `load( )` Loads a JobDescription from the database for the user set in this JobDescription. Loads a JobDescription from the database for the user set in this JobDescription. Todo Check that the ParameterSetting->numberOfChannels() exists!
`public`	# `copyFrom( hrm\job\JobDescription $aJobDescription )` Copies from another JobDescription into this JobDescription Copies from another JobDescription into this JobDescription Parameters `$aJobDescription` Another JobDescription.
`public boolean`	# `isCompound( )` Checks whether the JobDescription describes a compound Job. Checks whether the JobDescription describes a compound Job. Returns boolean True if the Job is compound (i.e. contains more than one file), false otherwise.
`public boolean`	# `createSubJobs( )` Creates elementary Jobs from compound Jobs. Creates elementary Jobs from compound Jobs. Returns boolean True if elementary Jobs could be created, false otherwise.
`public string`	# `sourceImageName( )` Returns the full file name without redundant slashes. Returns the full file name without redundant slashes. Returns string Full file name without redundant slashes. Todo Isn't this redundant? One could use the FileServer class!
`public string`	# `sourceImageNameWithoutPath( )` Returns the file name without path. Returns the file name without path. Returns string File name without path. Todo What about redundant slashes? Isn't this redundant? One could use the FileServer class!
`public string`	# `relativeSourcePath( )` Returns relative source path (under the image source path). Returns relative source path (under the image source path). Returns string Relative source path. Todo This must go into the Fileserver class!
`public string`	# `sourceImageShortName( )` Returns the file base name. Special handling for LIF, LOF and CZI files. Returns the file base name. Special handling for LIF, LOF and CZI files. Returns string File base name. Todo This must go into the Fileserver class!
`public string`	# `sourceFolder( )` Returns the source folder name. Returns the source folder name. Returns string Source folder name. Todo This must go into the Fileserver class!
`public string`	# `destinationImageName( )` Returns the destination image name without extension and without path. Returns the destination image name without extension and without path. Returns string Destination image name without extension and without path. Todo This must go into the Fileserver class!
`public string`	# `destinationImageNameWithoutPath( )` Returns the destination image name without path and with output file format extension. Returns the destination image name without path and with output file format extension. Returns string Destination image name without path and with output file format extension.
`public string`	# `destinationImageNameAndExtension( )` Returns the destination image name with selected output extension and relative path. Returns the destination image name with selected output extension and relative path. Returns string Destination image name with selected output extension and relative path.
`public string`	# `destinationImageFullName( )` Returns the destination image file name with full path. Returns the destination image file name with full path. Returns string Destination image file name with full path.
`public string`	# `destinationFolder( )` Returns the final destination folder name (also considering sub-folders created by the user in the image destination) Returns the final destination folder name (also considering sub-folders created by the user in the image destination) Returns string Destination folder name.
`public string`	# `taskSettingAsString( )` Convenience function to get all the parameters of the task setting. Convenience function to get all the parameters of the task setting. Returns string A string with all the parameters of the task setting.

Properties summary

`public string`	`$gpuId` The ID of the GPU card where to run the Job. The ID of the GPU card where to run the Job.	#
`public hrm\setting\ParameterSetting`	`$parameterSetting` The Job's ParameterSetting. The Job's ParameterSetting.	#
`public hrm\setting\TaskSetting`	`$taskSetting` The Job's TaskSetting. The Job's TaskSetting.	#
`public hrm\setting\AnalysisSetting`	`$analysisSetting` The Job's AnalysisSetting. The Job's AnalysisSetting.	#

Namespaces

Classes

Class JobDescription

Methods summary

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Todo

Parameters

Returns

Returns

Returns

Todo

Returns

Todo

Returns

Todo

Returns

Todo

Returns

Todo

Returns

Todo

Returns

Returns

Returns

Returns

Returns

Properties summary