Bio::EnsEMBL::Mapper::Gap Class Reference

Inheritance diagram for Bio::EnsEMBL::Mapper::Gap:

Public Member Functions
public Bio::EnsEMBL::Mapper::Gap	new ()
public Int	start ()
public String	end ()
public Int	length ()
public	rank ()

Detailed Description

Synopsis

Description

Representation of a gap in a sequence; returned from Mapper.pm when the
target region is in a gap.

Definition at line 14 of file Gap.pm.

Member Function Documentation

end()

public String Bio::EnsEMBL::Mapper::Gap::end

(

)

  Arg [1]    : (optional) int $newval
               The new value to set the end coordinate to
  Example    :

$end = $gap->end()

  Description: Getter/Setter for the end coordinate of the gap region
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

length()

public Int Bio::EnsEMBL::Mapper::Gap::length

(

)

  Arg [1]    : none
  Example    :

$len = $gap->length();

  Description: Getter for the length of this gap region
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

new()

public Bio::EnsEMBL::Mapper::Gap Bio::EnsEMBL::Mapper::Gap::new

(

)

  Arg [1]    : int $start
  Arg [2]    : int $end
  Example    :

$gap = Bio::EnsEMBL::Mapper::Gap($start, $end);

  Description: Creates a new Gap object.
  Returntype : Bio::EnsEMBL::Mapper::Gap
  Exceptions : none
  Caller     : Bio::EnsEMBL::Mapper
  Status     : Stable

Code:

rank()

public Bio::EnsEMBL::Mapper::Gap::rank

(

)

Undocumented method

Code:

start()

public Int Bio::EnsEMBL::Mapper::Gap::start

(

)

  Arg [1]    : (optional) int $start
               start coordinate of gap region
  Example    :

$start = $gap->start();

  Description: Getter/Setter for the start attribute
  Returntype : int
  Exceptions : none
  Caller     : general
  Status     : Stable

Code:

---

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

• ensembl/modules/Bio/EnsEMBL/Mapper/Gap.pm