Class: TechnicalAnalysis::MfiValue

Inherits:

Object

• Object
• TechnicalAnalysis::MfiValue

Defined in:

lib/technical_analysis/indicators/mfi.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.

• #mfi ⇒ Float

  The mfi calculation value.

Instance Method Summary

• #initialize(date_time: nil, mfi: nil) ⇒ MfiValue constructor

  A new instance of MfiValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, mfi: nil) ⇒ MfiValue

Returns a new instance of MfiValue.

# File 'lib/technical_analysis/indicators/mfi.rb', line 108

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

Instance Attribute Details

#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/mfi.rb', line 103

def date_time
  @date_time
end

#mfi ⇒ Float

Returns the mfi calculation value.

Returns:

• (Float) —

  the mfi calculation value

# File 'lib/technical_analysis/indicators/mfi.rb', line 106

def mfi
  @mfi
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/mfi.rb', line 114

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