Class: TechnicalAnalysis::VptValue

Inherits:

Object

• Object
• TechnicalAnalysis::VptValue

Defined in:

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

• #vpt ⇒ Float

  The vpt calculation value.

Instance Method Summary

• #initialize(date_time: nil, vpt: nil) ⇒ VptValue constructor

  A new instance of VptValue.

• #to_hash ⇒ Hash

  The attributes as a hash.

Constructor Details

#initialize(date_time: nil, vpt: nil) ⇒ VptValue

Returns a new instance of VptValue.

# File 'lib/technical_analysis/indicators/vpt.rb', line 84

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

def date_time
  @date_time
end

#vpt ⇒ Float

Returns the vpt calculation value.

Returns:

• (Float) —

  the vpt calculation value

# File 'lib/technical_analysis/indicators/vpt.rb', line 82

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

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