Class: TechnicalAnalysis::AtrValue

Inherits:

Object

• Object
• TechnicalAnalysis::AtrValue

Defined in:

lib/technical_analysis/indicators/atr.rb

Overview

The value class to be returned by calculations

Instance Attribute Summary

• #atr ⇒ Float

  The atr calculation value.

• #date_time ⇒ String

  The date_time of the obversation as it was provided.

Instance Method Summary

• #initialize(date_time: nil, atr: nil) ⇒ AtrValue constructor

  A new instance of AtrValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, atr: nil) ⇒ AtrValue

Returns a new instance of AtrValue.

# File 'lib/technical_analysis/indicators/atr.rb', line 98

def initialize(date_time: nil, atr: nil)
  @date_time = date_time
  @atr = atr
end

Instance Attribute Details

#atr ⇒ Float

Returns the atr calculation value.

Returns:

• (Float) —

  the atr calculation value

# File 'lib/technical_analysis/indicators/atr.rb', line 96

def atr
  @atr
end

#date_time ⇒ String

Returns the date_time of the obversation as it was provided.

Returns:

• (String) —

  the date_time of the obversation as it was provided

# File 'lib/technical_analysis/indicators/atr.rb', line 93

def date_time
  @date_time
end

Instance Method Details

#to_hash ⇒ Hash

Returns the attributes as a hash.

Returns:

• (Hash) —

  the attributes as a hash

# File 'lib/technical_analysis/indicators/atr.rb', line 104

def to_hash
  { date_time: @date_time, atr: @atr }
end