Class: Dtn::Lookups::Historical::Datapoint

Inherits:
Base
  • Object
show all
Defined in:
lib/dtn/lookups/historical/datapoint.rb

Overview

Weekly datapoint requests

Direct Known Subclasses

DailyDatapoint, MonthlyDatapoint, WeeklyDatapoint

Constant Summary

Constants inherited from Base

Base::DEFAULT_BEGIN_FILTER_TIME, Base::DEFAULT_DATAPOINTS_PER_SEND, Base::DEFAULT_DATA_DIRECTION, Base::DEFAULT_END_FILTER_TIME, Base::DEFAULT_MAX_DATAPOINTS

Constants included from Concerns::Validation

Concerns::Validation::DATE_FORMAT, Concerns::Validation::DATE_TIME_FORMAT, Concerns::Validation::DEFAULT_INTERVAL_TYPE, Concerns::Validation::MAX_INT16

Constants inherited from Request

Request::END_OF_MESSAGE_CHARACTERS, Request::NO_DATA_CHARACTERS, Request::PORT, Request::SYNTAX_ERROR_CHARACTERS

Instance Attribute Summary

Attributes inherited from Request

#combined_options

Instance Method Summary collapse

Methods inherited from Request

call

Methods included from Concerns::Id

#id

Instance Method Details

#call(symbol:, **options) ⇒ Object

Retrieves up to [maxDatapoints] datapoints of composite daily/weekly/monthly datapoints for the specified [Symbol].

Example messages

HDX,[Symbol],[MaxDatapoints],[DataDirection],[RequestID],[DatapointsPerSend]<CR><LF>
HWX,[Symbol],[MaxDatapoints],[DataDirection],[RequestID],[DatapointsPerSend]<CR><LF>
HMX,[Symbol],[MaxDatapoints],[DataDirection],[RequestID],[DatapointsPerSend]<CR><LF>



16
17
18
19
 
# File 'lib/dtn/lookups/historical/datapoint.rb', line 16

def call(symbol:, **options)
  self.combined_options = defaults(**options).merge(symbol: validate_symbol(symbol))
  super
end

#expected_messages_class ⇒ Object 



21
22
23
 
# File 'lib/dtn/lookups/historical/datapoint.rb', line 21

def expected_messages_class
  Messages::Historical::DailyWeeklyMonthly
end