Class: RubyTechnicalAnalysis::PriceChannel

Inherits:
Indicator
  • Object
show all
Defined in:
lib/ruby_technical_analysis/indicators/price_channel.rb

Overview

Price Channel

Find more information at: www.investopedia.com/terms/p/price-channel.asp

Instance Attribute Summary collapse

Attributes inherited from Indicator

#series

Instance Method Summary collapse

Methods inherited from Indicator

call

Constructor Details

#initialize(series: [], period: 20) ⇒ PriceChannel

Returns a new instance of PriceChannel.

Parameters:

  • series (Array) (defaults to: []) —

    An array of arrays containing high, low prices, e.g. [[high, low], [high, low]]

  • period (Integer) (defaults to: 20) —

    The number of periods to use in the calculation



10
11
12
13
14
 
# File 'lib/ruby_technical_analysis/indicators/price_channel.rb', line 10

def initialize(series: [], period: 20)
  @period = period

  super(series: series)
end

Instance Attribute Details

#period ⇒ Object (readonly)

Returns the value of attribute period.



6
7
8
 
# File 'lib/ruby_technical_analysis/indicators/price_channel.rb', line 6

def period
  @period
end

Instance Method Details

#call ⇒ Array

Returns An array containing the current upper and lower price channel values.

Returns:

  • (Array) —

    An array containing the current upper and lower price channel values



17
18
19
 
# File 'lib/ruby_technical_analysis/indicators/price_channel.rb', line 17

def call
  calculate_price_channel
end

#valid? ⇒ Boolean

Returns Whether the object is valid.

Returns:

  • (Boolean) —

    Whether the object is valid



22
23
24
 
# File 'lib/ruby_technical_analysis/indicators/price_channel.rb', line 22

def valid?
  series.length >= period
end