Class: Bio::References
Overview
DESCRIPTION
A container class for Bio::Reference objects.
USAGE
refs = Bio::References.new
refs.append(Bio::Reference.new(hash))
refs.each do |reference|
...
end
Instance Attribute Summary collapse
-
#references ⇒ Object
Array of Bio::Reference objects.
Instance Method Summary collapse
-
#append(reference) ⇒ Object
Add a Bio::Reference object to the container.
-
#each ⇒ Object
Iterate through Bio::Reference objects.
-
#initialize(ary = []) ⇒ References
constructor
Create a new Bio::References object.
Constructor Details
#initialize(ary = []) ⇒ References
Create a new Bio::References object
refs = Bio::References.new
Arguments:
-
(optional) __: Array of Bio::Reference objects
- Returns
-
Bio::References object
590 591 592 |
# File 'lib/bio/reference.rb', line 590 def initialize(ary = []) @references = ary end |
Instance Attribute Details
#references ⇒ Object
Array of Bio::Reference objects
581 582 583 |
# File 'lib/bio/reference.rb', line 581 def references @references end |
Instance Method Details
#append(reference) ⇒ Object
Add a Bio::Reference object to the container.
refs.append(reference)
Arguments:
-
(required) reference: Bio::Reference object
- Returns
-
current Bio::References object
602 603 604 605 |
# File 'lib/bio/reference.rb', line 602 def append(reference) @references.push(reference) if reference.is_a? Reference return self end |
#each ⇒ Object
Iterate through Bio::Reference objects.
refs.each do |reference|
...
end
- Block
-
yields each Bio::Reference object
614 615 616 617 618 |
# File 'lib/bio/reference.rb', line 614 def each @references.each do |reference| yield reference end end |