Class: Bio::PhyloXML::Distribution

Inherits:
Object
  • Object
show all
Defined in:
lib/bio/db/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


414
415
416
417
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 414

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

Instance Attribute Details

#descObject

String. Free text description of location.


408
409
410
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 408

def desc
  @desc
end

#pointsObject

Array of Point objects. Holds coordinates of the location.


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

def points
  @points
end

#polygonsObject

Array of Polygon objects.


412
413
414
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 412

def polygons
  @polygons
end

Instance Method Details

#to_xmlObject

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


421
422
423
424
425
426
427
428
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 421

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