Class: TechnicalAnalysis::KstValue

Inherits:

Object

• Object
• TechnicalAnalysis::KstValue

Defined in:

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

• #kst ⇒ Float

  The kst calculation value.

Instance Method Summary

• #initialize(date_time: nil, kst: nil) ⇒ KstValue constructor

  A new instance of KstValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, kst: nil) ⇒ KstValue

Returns a new instance of KstValue.

# File 'lib/technical_analysis/indicators/kst.rb', line 121

def initialize(date_time: nil, kst: nil)
  @date_time = date_time
  @kst = kst
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/kst.rb', line 116

def date_time
  @date_time
end

#kst ⇒ Float

Returns the kst calculation value.

Returns:

• (Float) —

  the kst calculation value

# File 'lib/technical_analysis/indicators/kst.rb', line 119

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

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