Class: Bio::PhyloXML::BranchColor

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

#blue ⇒ Object

Integer



744
745
746
 
# File 'lib/bio/phyloxml/elements.rb', line 744

def blue
  @blue
end

#green ⇒ Object

Integer



744
745
746
 
# File 'lib/bio/phyloxml/elements.rb', line 744

def green
  @green
end

#red ⇒ Object

Integer



744
745
746
 
# File 'lib/bio/phyloxml/elements.rb', line 744

def red
  @red
end

Instance Method Details

#to_xml ⇒ Object

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



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/bio/phyloxml/elements.rb', line 759

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