Class: Bio::PhyloXML::Distribution

Inherits:
Object
  • Object
show all
Defined in:
lib/bio-phyloxml/phyloxml_elements.rb

Overview

Description

The geographic distribution of the items of a clade (species, sequences), intended for phylogeographic applications.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDistribution

Returns a new instance of Distribution.



409
410
411
412
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 409

def initialize
  @points = []
  @polygons = []
end

Instance Attribute Details

#descObject

String. Free text description of location.



403
404
405
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 403

def desc
  @desc
end

#pointsObject

Array of Point objects. Holds coordinates of the location.



405
406
407
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 405

def points
  @points
end

#polygonsObject

Array of Polygon objects.



407
408
409
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 407

def polygons
  @polygons
end

Instance Method Details

#to_xmlObject

Converts elements to xml representation. Called by PhyloXML::Writer class.



416
417
418
419
420
421
422
423
# File 'lib/bio-phyloxml/phyloxml_elements.rb', line 416

def to_xml
  distr = LibXML::XML::Node.new('distribution')
  PhyloXML::Writer.generate_xml(distr, self, [
      [:simple, 'desc', @desc],
      [:objarr, 'point', 'points'],
      [:objarr, 'polygon', 'polygons']])
  return distr
end