Class: TechnicalAnalysis::ViValue

Inherits:

Object

• Object
• TechnicalAnalysis::ViValue

Defined in:

lib/technical_analysis/indicators/vi.rb

Overview

The value class to be returned by calculations

Instance Attribute Summary

• #date_time ⇒ String

  The date_time of the obversation as it was provided.

• #negative_vi ⇒ Float

  The negative Vortex Indicator value.

• #positive_vi ⇒ Float

  The positive Vortex Indicator value.

Instance Method Summary

• #initialize(date_time: nil, positive_vi: nil, negative_vi: nil) ⇒ ViValue constructor

  A new instance of ViValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, positive_vi: nil, negative_vi: nil) ⇒ ViValue

# File 'lib/technical_analysis/indicators/vi.rb', line 105

def initialize(date_time: nil, positive_vi: nil, negative_vi: nil)
  @date_time = date_time
  @positive_vi = positive_vi
  @negative_vi = negative_vi
end

Instance Attribute Details

#date_time ⇒ String

# File 'lib/technical_analysis/indicators/vi.rb', line 97

def date_time
  @date_time
end

#negative_vi ⇒ Float

# File 'lib/technical_analysis/indicators/vi.rb', line 103

def negative_vi
  @negative_vi
end

#positive_vi ⇒ Float

# File 'lib/technical_analysis/indicators/vi.rb', line 100

def positive_vi
  @positive_vi
end

Instance Method Details

#to_hash ⇒ Hash

# File 'lib/technical_analysis/indicators/vi.rb', line 112

def to_hash
  { date_time: @date_time, positive_vi: @positive_vi, negative_vi: @negative_vi }
end