Huygens Remote Manager
  • Namespace
  • Class
  • Tree
  • Todo

Namespaces

  • hrm
    • job
    • param
      • base
    • setting
      • base
    • shell
    • stats
    • user
      • proxy

Classes

  • Job
  • JobDescription
  • JobQueue

Class Job

Stores all information for a deconvolution Job.

Namespace: hrm\job
Located at job/Job.php

Methods summary

public
# __construct( hrm\job\JobDescription $jobDescription )

Job constructor.

Job constructor.

Parameters

$jobDescription
object.
public hrm\job\JobDescription
# description( )

Returns the JobDescription associated with the Job.

Returns the JobDescription associated with the Job.

Returns

hrm\job\JobDescription
The JobDescription object.
public
# setServer( string $server )

Sets the server which will run the Job.

Sets the server which will run the Job.

Parameters

$server
Server name.
public string
# server( )

Returns the name of the server associated with the Job.

Returns the name of the server associated with the Job.

Returns

string
Server name.
public
# setGPU( string $gpu )

Sets the GPU card which will run the Job at server 'server'.

Sets the GPU card which will run the Job at server 'server'.

Parameters

$gpu
GPU identifier.
public string
# gpu( )

Returns the name of the GPU card associated with the Job.

Returns the name of the GPU card associated with the Job.

Returns

string
GPU identifier.
public string
# getHuTemplate( )

Returns the Huygens template generated for the Job.

Returns the Huygens template generated for the Job.

Returns

string
Huygens Template.
public integer
# pid( )

Returns the process identifier associated with the Job.

Returns the process identifier associated with the Job.

Returns

integer
Process identifier.
public string
# id( )

Returns the \hrm\Job id.

Returns the \hrm\Job id.

Returns

string
Job id.
public
# setPid( integer $pid )

Sets the process identifier associated with the Job.

Sets the process identifier associated with the Job.

Parameters

$pid
Process identifier.
public string
# status( )

Returns the Job status.

Returns the Job status.

Returns

string
Job status.
public
# setStatus( string $status )

Sets the status of the Job.

Sets the status of the Job.

Parameters

$status
Status of the Job.
public
# createHuygensTemplate( )

Creates and sets a Huygens Template.

Creates and sets a Huygens Template.

public string
# huTemplateName( )

Returns the Huygens template name (it contains the unique id)

Returns the Huygens template name (it contains the unique id)

Returns

string
The template name.
public boolean
# createSubJobsOrHuTemplate( )

Creates a Huygens Template for elementary jobs or splits compound jobs.

Creates a Huygens Template for elementary jobs or splits compound jobs.

Returns

boolean

For elementary jobs, returns true if the template was generated successfully, or false otherwise; for compound jobs, it always returns false.

public boolean
# writeHuTemplate( )

Writes the template to the user's source folder.

Writes the template to the user's source folder.

Returns

boolean
True if the template could be written, false otherwise.
public boolean
# checkResultImage( )

Checks whether the result image is present in the destination directory.

Checks whether the result image is present in the destination directory.

Returns

boolean
True if the result image could be found, false otherwise

Todo

Refactor!
public boolean
# checkProcessFinished( )

Checks if the process is finished.

Checks if the process is finished.

Returns

boolean
True if the process is finished, false otherwise.

Todo

Refactor!
Huygens Remote Manager API documentation generated by ApiGen