Class: Bio::PhyloXML::Distribution

Inherits:

Object

• Object
• Bio::PhyloXML::Distribution

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

• #desc ⇒ Object

  String.

• #points ⇒ Object

  Array of Point objects.

• #polygons ⇒ Object

  Array of Polygon objects.

Instance Method Summary

• #initialize ⇒ Distribution constructor

  A new instance of Distribution.

• #to_xml ⇒ Object

  Converts elements to xml representation.

Constructor Details

#initialize ⇒ Distribution

Returns a new instance of Distribution.

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

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

Instance Attribute Details

#desc ⇒ Object

String. Free text description of location.

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

def desc
  @desc
end

#points ⇒ Object

Array of Point objects. Holds coordinates of the location.

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

def points
  @points
end

#polygons ⇒ Object

Array of Polygon objects.

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

def polygons
  @polygons
end

Instance Method Details

#to_xml ⇒ Object

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

# 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