Class: TechnicalAnalysis::Adx::AdxValue

Inherits:

Object

• Object
• TechnicalAnalysis::Adx::AdxValue

Defined in:

lib/technical_analysis/indicators/adx.rb

Overview

The value class to be returned by calculations

Instance Attribute Summary

• #adx ⇒ Float

  The adx calculation value.

• #date_time ⇒ String

  The date_time of the obversation as it was provided.

• #di_neg ⇒ Float

  The negative directional indicator calculation value.

• #di_pos ⇒ Float

  The positive directional indicator calculation value.

Instance Method Summary

• #initialize(date_time: nil, adx: nil, di_pos: nil, di_neg: nil) ⇒ AdxValue constructor

  A new instance of AdxValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, adx: nil, di_pos: nil, di_neg: nil) ⇒ AdxValue

# File 'lib/technical_analysis/indicators/adx.rb', line 153

def initialize(date_time: nil, adx: nil, di_pos: nil, di_neg: nil)
  @date_time = date_time
  @adx = adx
  @di_pos = di_pos
  @di_neg = di_neg
end

Instance Attribute Details

#adx ⇒ Float

# File 'lib/technical_analysis/indicators/adx.rb', line 145

def adx
  @adx
end

#date_time ⇒ String

# File 'lib/technical_analysis/indicators/adx.rb', line 142

def date_time
  @date_time
end

#di_neg ⇒ Float

# File 'lib/technical_analysis/indicators/adx.rb', line 151

def di_neg
  @di_neg
end

#di_pos ⇒ Float

# File 'lib/technical_analysis/indicators/adx.rb', line 148

def di_pos
  @di_pos
end

Instance Method Details

#to_hash ⇒ Hash

# File 'lib/technical_analysis/indicators/adx.rb', line 161

def to_hash
  { date_time: @date_time, adx: @adx, di_pos: @di_pos, di_neg: @di_neg }
end