Bio::EnsEMBL::Hive::RunnableDB::Dummy Class Reference

Inheritance diagram for Bio::EnsEMBL::Hive::RunnableDB::Dummy:

Public Member Functions
public	param_defaults ()
public	fetch_input ()
public	run ()
public	write_output ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::Process
public	new ()
public	life_cycle ()
public	say_with_header ()
public	enter_status ()
public	warning ()
public	param_defaults ()
public	fetch_input ()
public	run ()
public	write_output ()
public Bio::EnsEMBL::Hive::Worker	worker ()
public	execute_writes ()
public Bio::EnsEMBL::Hive::DBSQL::DBAdaptor	db ()
public Bio::EnsEMBL::Hive::DBSQL::DBConnection	dbc ()
public Bio::EnsEMBL::Hive::DBSQL::DBConnection	data_dbc ()
public Returns	run_system_command ()
public Bio::EnsEMBL::Hive::AnalysisJob	input_job ()
public	input_id ()
public	param ()
public	param_required ()
public	param_exists ()
public	param_is_defined ()
public	param_substitute ()
public	dataflow_output_id ()
public	dataflow_output_ids_from_json ()
public	throw ()
public This	complete_early ()
public Int	debug ()
public	worker_temp_directory ()
public	cleanup_worker_temp_directory ()

Detailed Description

Synopsis

standaloneJob.pl Bio::EnsEMBL::Hive::RunnableDB::Dummy -input_id "{}"
 
standaloneJob.pl Bio::EnsEMBL::Hive::RunnableDB::Dummy -input_id "{take_time=>3}"
 
standaloneJob.pl Bio::EnsEMBL::Hive::RunnableDB::Dummy -input_id "{take_time=>'rand(3)+1'}"

Description

    A job of 'Bio::EnsEMBL::Hive::RunnableDB::Dummy' analysis does not do any work by itself,
    but it benefits from the side-effects that are associated with having an analysis.

    For example, if a dataflow rule is linked to the analysis then
    every job that is created or flown into this analysis will be dataflown further according to this rule.

    param('take_time'):     How much time to spend sleeping (floating point seconds);
                            can be given by a runtime-evaluated formula; useful for testing.

Definition at line 28 of file Dummy.pm.

Member Function Documentation

fetch_input()

public Bio::EnsEMBL::Hive::RunnableDB::Dummy::fetch_input

(

)

    Description : Implements fetch_input() interface method of Bio::EnsEMBL::Hive::Process that is used to read in parameters and load data.
                  Here we simply override this method so that nothing is done.

Code:

param_defaults()

public Bio::EnsEMBL::Hive::RunnableDB::Dummy::param_defaults

(

)

    Description : Implements param_defaults() interface method of Bio::EnsEMBL::Hive::Process that defines module defaults for parameters.

Code:

run()

public Bio::EnsEMBL::Hive::RunnableDB::Dummy::run

(

)

    Description : Implements run() interface method of Bio::EnsEMBL::Hive::Process that is used to perform the main bulk of the job (minus input and output).
                  Since this Runnable is a Dummy, it does nothing. But it can also optionally sleep for param('take_time') seconds.

Code:

write_output()

public Bio::EnsEMBL::Hive::RunnableDB::Dummy::write_output

(

)

    Description : Implements write_output() interface method of Bio::EnsEMBL::Hive::Process that is used to deal with job's output after the execution.
                  Here we simply override this method so that nothing is done.

Code:

---

The documentation for this class was generated from the following file:

• modules/Bio/EnsEMBL/Hive/RunnableDB/Dummy.pm