Class: Bio::PhyloXML::BranchColor

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

Overview

Description

This indicates the color of a node when rendered (the color applies to the whole node and its children unless overwritten by the color(s) of sub clades).

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#blueObject

Integer


761
762
763
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 761

def blue
  @blue
end

#greenObject

Integer


761
762
763
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 761

def green
  @green
end

#redObject

Integer


761
762
763
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 761

def red
  @red
end

Instance Method Details

#to_xmlObject

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


776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
# File 'lib/bio/db/phyloxml/phyloxml_elements.rb', line 776

def to_xml
  #@todo add unit test
  if @red == nil
    raise "Subelement red of BranchColor element should not be nil"
  elsif @green == nil
    raise "Subelement green of BranchColor element should not be nil"
  elsif @blue == nil
    raise "Subelement blue of BranchColor element should not be nil"
  end

  c = LibXML::XML::Node.new('branch_color')
  PhyloXML::Writer.generate_xml(c, self, [
      [:simple, 'red', @red],
      [:simple, 'green', @green],
      [:simple, 'blue', @blue]])
  return c
end