Bio::EnsEMBL::Hive::Beekeeper Class Reference

Inheritance diagram for Bio::EnsEMBL::Hive::Beekeeper:

Public Member Functions
public Bio::EnsEMBL::Hive::Beekeeper	new_from_Valley ()
public	meadow_host ()
public	meadow_user ()
public	process_id ()
public	is_blocked ()
public	cause_of_death ()
public	sleep_minutes ()
public	analyses_pattern ()
public	loop_limit ()
public	loop_until ()
public	options ()
public	meadow_signatures ()
public	meadow ()
public void	set_cause_of_death ()
public Boolean	check_if_blocked ()
public String	toString ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::Storable
public Bio::EnsEMBL::Hive::Storable	new ()
public Int	dbID ()
public Bio::EnsEMBL::Hive::DBSQL::BaseAdaptor	adaptor ()
public	DESTROY ()
public	AUTOLOAD ()
Public Member Functions inherited from Bio::EnsEMBL::Hive::Cacheable
public	hive_pipeline ()
public	is_local_to ()
public	count_local_and_remote_objects ()
public	relative_display_name ()
public	relative_url ()
public	display_name ()
public	unikey ()

Detailed Description

Description

    A light-weight object to record a Beekeeper instance.

    This object does not perform any of tasks beekeeper do (submitting jobs, etc),
    its purpose is merely to record the fact that a beekeeper has been run, and
    update its status.

Definition at line 13 of file Beekeeper.pm.

Member Function Documentation

analyses_pattern()

public Bio::EnsEMBL::Hive::Beekeeper::analyses_pattern

(

)

Undocumented method

Code:

cause_of_death()

public Bio::EnsEMBL::Hive::Beekeeper::cause_of_death

(

)

Undocumented method

Code:

check_if_blocked()

public Boolean Bio::EnsEMBL::Hive::Beekeeper::check_if_blocked

(

)

  Example     :

my $check_if_blocked = $beekeeper->check_if_blocked();

  Description : Updates the object with the freshest value of is_blocked coming from the database
                for this beekeeper, and return the new value.
  Returntype  : Boolean
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

is_blocked()

public Bio::EnsEMBL::Hive::Beekeeper::is_blocked

(

)

Undocumented method

Code:

loop_limit()

public Bio::EnsEMBL::Hive::Beekeeper::loop_limit

(

)

Undocumented method

Code:

loop_until()

public Bio::EnsEMBL::Hive::Beekeeper::loop_until

(

)

Undocumented method

Code:

meadow()

public Bio::EnsEMBL::Hive::Beekeeper::meadow

(

)

Undocumented method

Code:

meadow_host()

public Bio::EnsEMBL::Hive::Beekeeper::meadow_host

(

)

Undocumented method

Code:

meadow_signatures()

public Bio::EnsEMBL::Hive::Beekeeper::meadow_signatures

(

)

Undocumented method

Code:

meadow_user()

public Bio::EnsEMBL::Hive::Beekeeper::meadow_user

(

)

Undocumented method

Code:

new_from_Valley()

public Bio::EnsEMBL::Hive::Beekeeper Bio::EnsEMBL::Hive::Beekeeper::new_from_Valley

(

)

  Example     :

my $new_from_Valley = Bio::EnsEMBL::Hive::Beekeeper->new_from_Valley($valley);

  Description : A specific constructor that sets all the fields according to the given Valley.
  Returntype  : Bio::EnsEMBL::Hive::Beekeeper
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

options()

public Bio::EnsEMBL::Hive::Beekeeper::options

(

)

Undocumented method

Code:

process_id()

public Bio::EnsEMBL::Hive::Beekeeper::process_id

(

)

Undocumented method

Code:

set_cause_of_death()

public void Bio::EnsEMBL::Hive::Beekeeper::set_cause_of_death

(

)

  Example     :

$beekeeper->set_cause_of_death('LOOP_LIMIT');

  Description : Set the "cause of death" of this beekeeper in the object and in the database.
  Returntype  : none
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

sleep_minutes()

public Bio::EnsEMBL::Hive::Beekeeper::sleep_minutes

(

)

Undocumented method

Code:

toString()

public String Bio::EnsEMBL::Hive::Beekeeper::toString

(

)

  Example     :

print $beekeeper->toString();

  Description : Produces a string summary of properties of this beekeeper.
  Returntype  : String
  Exceptions  : none
  Caller      : general
  Status      : Stable

Code:

---

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

• modules/Bio/EnsEMBL/Hive/Beekeeper.pm