Archive Ensembl HomeArchive Ensembl Home
Bio::EnsEMBL::IdMapping::Entry Class Reference

List of all members.


Class Summary

Synopsis

Description

This object represents a ScoredMappingMatrix entry. It is defined by a
pair of a source and target object's internal Id and a score for this
mapping.
 

Definition at line 16 of file Entry.pm.

Available Methods

public A new ()
public A new_fast ()
public Float score ()
public Int source ()
public Int target ()
public String to_string ()

Method Documentation

public A Bio::EnsEMBL::IdMapping::Entry::new ( )
  Example     : my $entry = Bio::EnsEMBL::IdMapping::Entry->new();
  Description : Constructor. This is a no-argument constructor, so you need to
                populate the object manually. Rarely used since in most cases
                new_fast() is preferred.
  Return type : a Bio::EnsEMBL::IdMapping::Entry object
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view
public A Bio::EnsEMBL::IdMapping::Entry::new_fast ( )
  Arg[1]      : Arrayref $array_ref - the arrayref to bless into the Entry
                object 
  Example     : my $entry = Bio::EnsEMBL::IdMapping::Entry->new_fast([
                  $source_gene->id, $target_gene->id, 0.9]);
  Description : Fast constructor.
  Return type : a Bio::EnsEMBL::IdMapping::Entry object
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view
public Float Bio::EnsEMBL::IdMapping::Entry::score ( )
  Arg[1]      : (optional) Float - a score
  Description : Getter/setter for score for the mapping between source and
                target object.
  Return type : Float
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view
public Int Bio::EnsEMBL::IdMapping::Entry::source ( )
  Arg[1]      : (optional) Int - source object's internal Id
  Description : Getter/setter for source object's internal Id.
  Return type : Int
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view
public Int Bio::EnsEMBL::IdMapping::Entry::target ( )
  Arg[1]      : (optional) Int - target object's internal Id
  Description : Getter/setter for target object's internal Id.
  Return type : Int
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view
public String Bio::EnsEMBL::IdMapping::Entry::to_string ( )
  Example     : print LOG $entry->to_string, "\\n";
  Description : Returns a string representation of the Entry object. Useful for
                debugging and logging.
  Return type : String
  Exceptions  : none
  Caller      : general
  Status      : At Risk
              : under development
 
Code:
click to view

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