Bio::Map PositionI
SummaryIncluded librariesPackage variablesSynopsisDescriptionGeneral documentationMethods
Summary
Bio::Map::PositionI - Abstracts the notion of a position having
a value in the context of a marker and a Map
Package variables
No package variables defined.
Included modules
Bio::Root::RootI
Carp
Inherit
Bio::Root::RootI
Synopsis
    # do not use directly
Description
This object stores one of the postions a that a mappable object
(e.g. Marker) may have in a map (e.g. restriction enzymes or a SNP
mapped to several chromosomes).
The method numeric() returns the position in a form that can be
compared between other positions of the same type.
Methods
mapDescriptionCode
markerDescriptionCode
valueDescriptionCode
numericDescriptionCode
Methods description
mapcode    nextTop
 Title   : map
 Usage   : my $id = map->$map;
 Function: Get/Set the map the position is in.
 Returns : Bio::Map::MapI
 Args    : [optional] new Bio::Map::MapI
markercodeprevnextTop
 Title   : marker
 Usage   : my $id = marker->$marker;
 Function: Get/Set the marker the position is in.
 Returns : Bio::Map::MarkerI
 Args    : [optional] new Bio::Map::MarkerI
valuecodeprevnextTop
 Title   : value
 Usage   : my $pos = $position->value;
 Function: Get/Set the value for this position
 Returns : scalar, value
 Args    : [optional] new value to set
numericcodeprevnextTop
 Title   : numeric
 Usage   : my $num = $position->numeric;
 Function: Read-only method that is guarantied to return 
           representation for this position that can be compared with others
 Returns : numeric (int, real or range)
 Args    : none
Methods code
mapdescriptionprevnextTop
sub map {
   my ($self, $value) = @_;
   $self->throw_not_implemented();
}
markerdescriptionprevnextTop
sub marker {
   my ($self, $value) = @_;
   $self->throw_not_implemented();
}
valuedescriptionprevnextTop
sub value {
   my ($self, $value) = @_;
   $self->throw_not_implemented();
}
numericdescriptionprevnextTop
sub numeric {
   my ($self) = @_;
   $self->throw_not_implemented();
}
General documentation
FEEDBACKTop
Mailing ListsTop
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
  bioperl-l@bioperl.org              - General discussion
  http://bioperl.org/MailList.shtml  - About the mailing lists
Reporting BugsTop
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
email or the web:
  bioperl-bugs@bioperl.org
  http://bugzilla.bioperl.org/
AUTHOR - Jason StajichTop
Email jason@bioperl.org
Describe contact details here
CONTRIBUTORSTop
Lincoln Stein, lstein@cshl.org
Heikki Lehvaslaiho, heikki@ebi.ac.uk
APPENDIXTop
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _