Class: TokyoMetro::Api::TrainTimetable

Inherits:
MetaClass::NotRealTime show all
Includes:
ClassNameLibrary::Api::TrainTimetable
Defined in:
lib/tokyo_metro/api/train_timetable.rb

Overview

列車時刻表 odpt:TrainTimetable を扱うクラス

See Also:

Defined Under Namespace

Classes: Info, List

クラスメソッド - データの取得・保存 collapse

Methods inherited from MetaClass::Fundamental

factory_for_generating_from_saved_file

Class Method Details

.get(http_client, id_urn: nil, same_as: nil, train_number: nil, railway_line: nil, operator: nil, train_type: nil, railway_direction: nil, starting_station: nil, terminal_station: nil, train_owner: nil, train: nil, parse_json: false, generate_instance: false, to_inspect: false) ⇒ ::Array

列車時刻表 odpt:TrainTimetable を取得するメソッド

Parameters:

  • http_client (HTTPClient) —

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

  • id_urn (String) (defaults to: nil) —

    固有識別子 (ucode) <id - URN>

  • same_as (String) (defaults to: nil) —

    固有識別子（命名ルールは「odpt.TrainTimetable:TokyoMetro.路線名.列車番号.曜日」） <owl:sameAs - URL>

  • train_number (String) (defaults to: nil) —

    列車番号 <odpt:trainNumber - xsd:string>

  • railway_line (String) (defaults to: nil) —

    路線 <odpt:railway - odpt:Railway>

  • operator (String) (defaults to: nil) —

    運行会社 <odpt:operator - odpt:Operator>

  • train_type (String) (defaults to: nil) —

    列車種別 <odpt:trainType - odpt:TrainType>

  • railway_direction (String) (defaults to: nil) —

    方面 <odpt:railDirection - odpt:RailDirection>

  • starting_station (String) (defaults to: nil) —

    列車の始発駅（他社線始発の場合のみ指定可能）<odpt:startingStation - odpt:Station>

  • terminal_station (String) (defaults to: nil) —

    列車の終着駅<odpt:terminalStation - odpt:Station>

  • train_owner (String) (defaults to: nil) —

    車両の所属会社<odpt:trainOwner - odpt:TrainOwner>

  • train (String) (defaults to: nil) —

    列車のID（odpt:Trainのowl:sameAsの値）<odpt:train - odpt:Train>

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

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

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

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

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

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

Returns:

  • (::Array) 


26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/tokyo_metro/api/train_timetable.rb', line 26

def self.get( http_client ,
  id_urn: nil , same_as: nil , train_number: nil , railway_line: nil ,
  operator: nil , train_type: nil , railway_direction: nil ,
  starting_station: nil , terminal_station: nil , train_owner: nil , train: nil ,
  parse_json: false , generate_instance: false , to_inspect: false )

  factory_for_getting.process( http_client , id_urn , same_as , train_number , railway_line ,
    operator , train_type , railway_direction ,
    starting_station , terminal_station , train_owner , train ,
    parse_json , generate_instance , to_inspect )
end

.save(http_client, filename, file_type: :yaml, id_urn: nil, same_as: nil, train_number: nil, railway_line: nil, operator: nil, train_type: nil, railway_direction: nil, starting_station: nil, terminal_station: nil, train_owner: nil, train: nil, to_inspect: false) ⇒ nil

列車時刻表 odpt:TrainTimetable を取得し保存するメソッド

Parameters:

  • http_client (HTTPClient) —

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

  • filename (String (filename)) —

    保存するファイルの名称【必須】

  • file_type (Symbol) (defaults to: :yaml) —

    保存するファイルの種類【必須】

  • id_urn (String) (defaults to: nil) —

    固有識別子 (ucode) <id - URN>

  • same_as (String) (defaults to: nil) —

    固有識別子（命名ルールは「odpt.TrainTimetable:TokyoMetro.路線名.列車番号.曜日」） <owl:sameAs - URL>

  • train_number (String) (defaults to: nil) —

    列車番号 <odpt:trainNumber - xsd:string>

  • railway_line (String) (defaults to: nil) —

    路線 <odpt:railway - odpt:Railway>

  • operator (String) (defaults to: nil) —

    運行会社 <odpt:operator - odpt:Operator>

  • train_type (String) (defaults to: nil) —

    列車種別 <odpt:trainType - odpt:TrainType>

  • railway_direction (String) (defaults to: nil) —

    方面 <odpt:railDirection - odpt:RailDirection>

  • starting_station (String) (defaults to: nil) —

    列車の始発駅（他社線始発の場合のみ指定可能）<odpt:startingStation - odpt:Station>

  • terminal_station (String) (defaults to: nil) —

    列車の終着駅<odpt:terminalStation - odpt:Station>

  • train_owner (String) (defaults to: nil) —

    車両の所属会社<odpt:trainOwner - odpt:TrainOwner>

  • train (String) (defaults to: nil) —

    列車のID（odpt:Trainのowl:sameAsの値）<odpt:train - odpt:Train>

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

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

Returns:

  • (nil) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/tokyo_metro/api/train_timetable.rb', line 55

def self.save( http_client , filename , file_type: :yaml ,
  id_urn: nil , same_as: nil , train_number: nil , railway_line: nil ,
  operator: nil , train_type: nil , railway_direction: nil ,
  starting_station: nil , terminal_station: nil , train_owner: nil , train: nil ,
  to_inspect: false )

  data = get( http_client ,
    id_urn: id_urn , same_as: same_as , train_number: train_number , railway_line: railway_line ,
    operator: operator , train_type: train_type , railway_direction: railway_direction ,
    starting_station: starting_station , terminal_station: terminal_station , train_owner: train_owner , train: train ,
    parse_json: true , generate_instance: false , to_inspect: to_inspect )

  save_data( data , filename , file_type: file_type )
end