Bio::EnsEMBL::Genome Class Reference

Public Member Functions
public Bio::EnsEMBL::Genome	new ()
public Bio::EnsEMBL::Genome	new_fast ()
public String	statistic ()
public String	code ()
public String	name ()
public String	description ()
public String	value ()
public String	dbID ()
public String	species_id ()

Detailed Description

Synopsis

use Bio::EnsEMBL::Genome;
 
my $genome = Bio::EnsEMBL::Genome->new
     (-NAME => 'myName',
      -CODE => 'MyCode',
      -DESCRIPTION => 'This is my statistics description.',
      -VALUE => '10023');
 
print $statistic->name(), "\n";
print $statistic->code(), "\n";
print $statistic->description(), "\n";
print $statistic->value(), "\n";

Description

This is a generic genome class used to represent statistics
associated with a genome and species

See-also

Bio::EnsEMBL::DBSQL::GenomeContainer

Definition at line 32 of file Genome.pm.

Member Function Documentation

code()

public String Bio::EnsEMBL::Genome::code

(

)

  Arg [1]    : string $code (optional)
  Example    :

$code = $genome->code();

  Description: Getter/Setter for code statistic
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

dbID()

public String Bio::EnsEMBL::Genome::dbID

(

)

  Arg [1]    : string $value (optional)
  Example    :

$dbID = $statistic->dbID();

  Description: Getter/Setter for statistic internal id
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

description()

public String Bio::EnsEMBL::Genome::description

(

)

  Arg [1]    : string $description (optional)
  Example    :

$description = $statistic->description();

  Description: Getter/Setter for description statistic
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

name()

public String Bio::EnsEMBL::Genome::name

(

)

  Arg [1]    : string $name (optional)
  Example    :

$name = $statistic->name();

  Description: Getter/Setter for the name associated to the statistic attribute
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

new()

public Bio::EnsEMBL::Genome Bio::EnsEMBL::Genome::new

(

)

  Arg [-NAME]        : string - the name for this statistic
  Arg [-CODE]        : string - the code for this statistic
  Arg [-DESCRIPTION] : string - a description for this statistic
  Arg [-VALUE]       : value  - the value of this statistic
  Example            :

 my $genome = Bio::EnsEMBL::Genome->new
                         (-name => 'myName',
                          -CODE => 'MyCode',
                          -DESCRIPTION => 'This is my statistics description.',
                          -VALUE => '10023');  
<br>

  Description        : Constructor.  Instantiates a Bio::EnsEMBL::Genome object.
  Returntype         : Bio::EnsEMBL::Genome
  Exceptions         : none
  Caller             : general
  Status             : Stable

Code:

new_fast()

public Bio::EnsEMBL::Genome Bio::EnsEMBL::Genome::new_fast

(

)

  Arg [1]    : hashref to be blessed
  Description: Construct a new Bio::EnsEMBL::Genome using the hashref.
  Exceptions : none
  Returntype : Bio::EnsEMBL::Genome
  Caller     : general, subclass constructors
  Status     : Stable

Code:

species_id()

public String Bio::EnsEMBL::Genome::species_id

(

)

  Arg [1]    : string $value (optional)
  Example    :

$species_id = $statistic->dbID();

  Description: Getter/Setter for statistic species id
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

statistic()

public String Bio::EnsEMBL::Genome::statistic

(

)

  Arg [1]    : string $statistic (optional)
  Example    :

$statistic = $statistic->name();

  Description: Getter/Setter for the statistic name
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

value()

public String Bio::EnsEMBL::Genome::value

(

)

  Arg [1]    : string $value (optional)
  Example    :

$value = $statistic->value();

  Description: Getter/Setter for value statistic
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

---

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

• ensembl/modules/Bio/EnsEMBL/Genome.pm