ensembl-hive  2.1
 All Classes Namespaces Files Functions Pages
Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether Class Reference
+ Inheritance diagram for Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether:
+ Collaboration diagram for Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether:

Public Member Functions

public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
protected _add_together ()
 
- Public Member Functions inherited from Bio::EnsEMBL::Hive::Process
public new ()
 
public life_cycle ()
 
public say_with_header ()
 
public enter_status ()
 
public warning ()
 
public strict_hash_format ()
 
public param_defaults ()
 
public fetch_input ()
 
public run ()
 
public write_output ()
 
public Bio::EnsEMBL::Hive::Worker worker ()
 
public Boolean 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
Bio::EnsEMBL::Hive::AnalysisJob 
input_job ()
 
public input_id ()
 
public param ()
 
public param_required ()
 
public param_is_defined ()
 
public param_substitute ()
 
public dataflow_output_id ()
 
public throw ()
 
public complete_early ()
 
public Int debug ()
 
public worker_temp_directory ()
 
public worker_temp_directory_name ()
 
public cleanup_worker_temp_directory ()
 

Detailed Description

Synopsis

Please refer to Bio::EnsEMBL::Hive::PipeConfig::LongMult_conf pipeline configuration file
to understand how this particular example pipeline is configured and ran.

Description

    'LongMult::AddTogether' is the final step of the pipeline that, naturally, adds the products together
    and stores the result in 'final_result' database table.

Member Function Documentation

protected Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether::_add_together ( )
    Description: this is a private function (not a method) that adds all the products with a shift
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether::fetch_input ( )
    Description : Implements fetch_input() interface method of Bio::EnsEMBL::Hive::Process that is used to read in parameters and load data.
                  Here all relevant partial products are fetched from the 'partial_product' accumulator and stored in a hash for future use.
    param('a_multiplier'):  The first long number (a string of digits - doesn't have to fit a register).
    param('b_multiplier'):  The second long number (also a string of digits).
    param('take_time'):     How much time to spend sleeping (seconds).
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether::param_defaults ( )
    Description : Implements param_defaults() interface method of Bio::EnsEMBL::Hive::Process that defines module defaults for parameters.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether::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).
                  The only thing we do here is make a call to the function that will add together the intermediate results.
 
Code:
click to view
public Bio::EnsEMBL::Hive::RunnableDB::LongMult::AddTogether::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.
                  Dataflows both original multipliers and the final result down branch-1, which will be routed into 'final_result' table.
 
Code:
click to view

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