Module: TokyoMetro::Modules::Api::ToFactory::Get::Geo::ClassMethods

Defined in:
lib/tokyo_metro/modules/api/to_factory/get/geo.rb

Instance Method Summary collapse

Instance Method Details

#factory_for_getting_geo ⇒ Const (class)

地物情報検索 API からデータを取得するための Factory Pattern クラス

Returns:

  • (Const (class))

Raises:

  • (RuntimeError) —

    サブクラスで定義するため、このクラスでは例外が発生するようにしている。



26
27
28
 
# File 'lib/tokyo_metro/modules/api/to_factory/get/geo.rb', line 26

def factory_for_getting_geo
  "The class method \"#{__method__}\" is not defined yet in this class."
end

#get_geo(http_client, long, lat, radius, parse_json: false, generate_instance: false, to_inspect: false) ⇒ ::Array <Hash>, String

地物情報検索 API からデータを取得するメソッド

Parameters:

  • http_client (HTTPClient) —

    HTTPClient のインスタンス【必須】

  • long (Numeric) —

    検索範囲の中心点の経度（10進表記）【必須】

  • lat (Numeric) —

    検索範囲の中心点の緯度（10進表記）【必須】

  • radius (Numeric) —

    検索範囲の半径 (m)【必須】

  • parse_json (Boolean) (defaults to: false) —

    JSONを配列とするか否かの設定（false の場合は文字列とする）

  • generate_instance (Boolean) (defaults to: false) —

    データ取得後に Ruby のインスタンスを作成するか否かの設定

  • to_inspect (Boolean) (defaults to: false) —

    データ取得後にコマンドツールに内容を表示するか否かの設定

Returns:

  • (::Array <Hash>) —

    parse_json が true の場合は、JSON を配列に変換して返す。

  • (String) —

    parse_json が false の場合は、JSON を文字列として返す。



18
19
20
21
 
# File 'lib/tokyo_metro/modules/api/to_factory/get/geo.rb', line 18

def get_geo( http_client , long , lat , radius , parse_json: false , generate_instance: false , to_inspect: false )
  factory_for_getting_geo.process( http_client , long , lat , radius ,
    parse_json , generate_instance , to_inspect )
end