Class: When::TM::PeriodDuration

Inherits:
Duration
  • Object
show all
Includes:
When, Coordinates
Defined in:
lib/when_exe/tmobjects.rb

Overview

ISO 8601 (JIS X0301) の時間間隔に基づいて定義された When::TM::Duration の subclass

Defined Under Namespace

Modules: NoDuration

Constant Summary

Constants included from Coordinates

Coordinates::Bahai, Coordinates::Common, Coordinates::DefaultDateIndices, Coordinates::DefaultDayIndex, Coordinates::DefaultTimeIndices, Coordinates::Indian, Coordinates::Iranian, Coordinates::Javanese, Coordinates::MATCH, Coordinates::Mayan, Coordinates::PERIOD, Coordinates::PERIOD_NAME, Coordinates::PRECISION, Coordinates::PRECISION_NAME, Coordinates::Tibetan, Coordinates::VALUE, Coordinates::Yi

Constants included from When

CENTURY, DAY, DECADE, EUCJP, HOUR, MINUTE, MONTH, MinusInfinity, P1D, P1M, P1W, P1Y, PT1H, PT1M, PT1S, PlusInfinity, RootDir, SECOND, STRING, SYSTEM, SourceURI, When::TimeValue, UTF8, VERSION, W31J, WEEK, YEAR

Constants inherited from Duration

Duration::DAY, Duration::DurationUnits, Duration::HOUR, Duration::MINUTE, Duration::MONTH, Duration::SECOND, Duration::SYSTEM, Duration::Unit, Duration::UnitName, Duration::WEEK, Duration::YEAR

Instance Attribute Summary collapse

Attributes inherited from Duration

#duration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Coordinates

to_deg, to_deg_225, to_dms

Methods included from When

Calendar, CalendarEra, CalendarNote, Clock, Duration, Index, Location, M17n, MonthName, Pair, Residue, Resource, TemporalPosition, Wikipedia, _const_missing, _define_common_calendar_types, _setup_, _setup_info, at, client, column, config, const_missing, era, free_conv, m17n, now, server, today, when?

Methods inherited from Duration

#_enumerator, #abs, #after, #before, #coerce, dhms, #inspect, #rational_duration, #to_as_duration, #to_dhms, #to_duration, #to_f, #to_i, #to_interval_length, unit, #unit

Constructor Details

#initialize(date = nil, time = nil, week = nil) ⇒ PeriodDuration #initialize(value, index, range = YEAR..SECOND) ⇒ PeriodDuration

オブジェクトの生成

Overloads:

  • #initialize(date = nil, time = nil, week = nil) ⇒ PeriodDuration

    Parameters:

    • date (Array<Numeric>) (defaults to: nil) —

      期間の日付要素

    • time (Array<Numeric>) (defaults to: nil) —

      期間の時刻要素

    • week (Array<Numeric>) (defaults to: nil) —

      期間の週日要素

  • #initialize(value, index, range = YEAR..SECOND) ⇒ PeriodDuration

    Parameters:

    • value (Numeric) —

      ndex に対応する桁での)時間間隔

    • index (Numeric) —

      When で定義している分解能定数(YEAR, … ,SECOND)

    • range (Range) (defaults to: YEAR..SECOND) —

      生成する桁の範囲



1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'lib/when_exe/tmobjects.rb', line 1245

def initialize(*args)
  @options = (args[-1].kind_of?(Hash)) ? (args.pop.reject {|key,value| value == nil}) : {}
  if args[0].kind_of?(Numeric)
    _initialize_by_unit(*args)
  else
    @date, @time, @week = args
  end
  _duration
end

Instance Attribute Details

#date ⇒ Array<Numeric>

期間の日付要素

Returns:



966
967
968
 
# File 'lib/when_exe/tmobjects.rb', line 966

def date
  @date
end

#time ⇒ Array<Numeric>

期間の時刻要素

Returns:



980
981
982
 
# File 'lib/when_exe/tmobjects.rb', line 980

def time
  @time
end

#to_day ⇒ Integer (readonly)

Note:

固定の整数で表現できない場合は nil

期間の日数

Returns:

  • (Integer) 


960
961
962
 
# File 'lib/when_exe/tmobjects.rb', line 960

def to_day
  @to_day
end

#week ⇒ Array<Numeric>

期間の週日要素

Returns:



973
974
975
 
# File 'lib/when_exe/tmobjects.rb', line 973

def week
  @week
end

Class Method Details

._to_array(period) ⇒ Array<Numeric, Array<Numeric>>

ISO 8601 形式の表現を分解して配列化する

Parameters:

Returns:

  • (Array<Numeric, Array<Numeric>>) —

    ( sign, date, time, week )

    sign [Numeric

    • +1 , -1 ]

    date [Array<Numeric>

    • 年月日 ]

    time [Array<Numeric>

    • 時分秒 ]

    week [Array<Numeric>

    • 週日 ]



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/when_exe/tmobjects.rb', line 896

def self._to_array(period)

  return nil unless period.gsub(/_+/, '') =~ /\A([-+])?P(.*?)?(?:T(.+))?\z/

  sign = ($1 == '-') ? -1 : +1
  pdate, ptime = $~[2..3]

  # 時分秒形式

  if (ptime =~ /\A(?:([.,\d]+)?([:*=])?H)?(?:([.,\d]+)?([:*=])?M)?(?:([.,\d]+)?([:*=])?S)?((?:[.,\d]*[:*=]?X)*)\z/)
    trunk = [1,3,5].map {|i|
        $~[i] ? Pair._en_pair($~[i], $~[i+1]) : 0
      }
    extra = $7 ? $7.scan(/([.,\d]+)?([:*=])?X/).map {|d|
        d[0] ? Pair._en_pair(d[0], d[1]) : 0
      } : []
    time = [0] + trunk + extra
    time = nil if time.uniq == [0]
  end

  case pdate
  # 年月日形式

  when /\A((?:[.,\d]*[-*=]?X)*)(?:([.,\d]+)?([-*=])?Y)?(?:([.,\d]+)?([-+*&%!>=<?])?M)?(?:([.,\d]+)?([-*=?%])?D)?\z/
    trunk = [2,4,6].map {|i|
        $~[i] ? Pair._en_pair($~[i], $~[i+1]) : 0
      }
    extra = $1 ? $1.scan(/([.,\d]+)?([:*=])?X/).map {|d|
        d[0] ? Pair._en_pair(d[0], d[1]) : 0
      } : []
    date = extra + trunk
    date = nil if date.uniq == [0]
    return sign, date, time

  # 週日形式

  when /\A(?:([.,\d]+)?([:*=])?W)(?:([.,\d]+)?([-*=?%])?D)?\z/
    week = [1,3].map {|i|
        $~[i] ? Pair._en_pair($~[i], $~[i+1]) : 0
      }
    return sign, nil, time if week.uniq == [0]
    date = [0,  0, week[1] + 7*week[0]]
    return sign, date, time, week

  # 代用形式

  else
    pdate += 'T' + ptime if ptime
    f, d, t, z, e = When::BasicTypes::DateTime._to_array(pdate, {:abbr=>[0]*20})
    return nil if e
    if d
      case f
      when :day          ; date       = [d[0], 0, d[1]]
      when :century, nil ; date       = (0..2).map {|i| d[i]||0}
      when :week         ; date, week = [0,0,d[0]*7+(d[1]||0)], [d[0], d[1]||0]
      end
    end
    time = t ? (t.map {|v| v||0}) : nil
    return sign, date, time, week
  end
end

Instance Method Details

#*(times) ⇒ When::TM::PeriodDuration

乗算

Parameters:

Returns:



1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lib/when_exe/tmobjects.rb', line 1179

def *(times)
  period = self.dup
  period.send(:date=, @date.map {|v| v *= times; v.to_i==v.to_f ? v.to_i : v}) if @date
  period.send(:week=, @week.map {|v| v *= times; v.to_i==v.to_f ? v.to_i : v}) if @week
  period.send(:time=, @time.map {|v| v *= times; v.to_i==v.to_f ? v.to_i : v}) if @time
  period.send(:_duration)
  return period
end

#+(other) ⇒ WWhen::TM::PeriodDuration, other と同じクラス

加算

Parameters:

Returns:

  • (WWhen::TM::PeriodDuration) —

    (other が When::TM::PeriodDuration の場合)

  • (other と同じクラス) —

    (other がその他の場合)



1159
1160
1161
 
# File 'lib/when_exe/tmobjects.rb', line 1159

def +(other)
  other.kind_of?(When::TM::PeriodDuration) ? _plus(other, +1) : other + self
end

#-(other) ⇒ When::TM::PeriodDuration

減算

Parameters:

Returns:



1169
1170
1171
 
# File 'lib/when_exe/tmobjects.rb', line 1169

def -(other)
  _plus(other, -1)
end

#-@ ⇒ When::TM::PeriodDuration

符号反転

Returns:



1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/when_exe/tmobjects.rb', line 1086

def -@
  period = self.dup
  period.send(:date=, @date.map {|v| -v}) if @date
  period.send(:week=, @week.map {|v| -v}) if @week
  period.send(:time=, @time.map {|v| -v}) if @time
  period.send(:_duration)
  return period
end

#/(divisor) ⇒ When::TM::PeriodDuration

除算

Parameters:

Returns:



1194
1195
1196
 
# File 'lib/when_exe/tmobjects.rb', line 1194

def /(divisor)
  self * (1.0 / divisor)
end

#<=>(other) ⇒ Integer

比較

Parameters:

Returns:

  • (Integer) —

    other との比較により、負,0,正の値を返す



1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/when_exe/tmobjects.rb', line 1112

def <=>(other)
  unless (@date && @date.size) == (other.date && other.date.size) &&
         (@week && @week.size) == (other.week && other.week.size) &&
         (@time && @time.size) == (other.time && other.time.size)
    raise ArgumentError, "PeriodDuration structure mismatch"
  end

  (0...@week.size).each do |i|
     sgn = +@week[i] <=> +other.week[i]
     return sgn unless sgn == 0
  end if @week

  (0...@date.size).each do |i|
     sgn = +@date[i] <=> +other.date[i]
     return sgn unless sgn == 0
  end if @date

  (0...@time.size).each do |i|
     sgn = +@time[i] <=> +other.time[i]
     return sgn unless sgn == 0
  end if @time

  return 0
end

#==(other) ⇒ Boolean

オブジェクトの同値

Parameters:

  • other (比較先)

Returns:

  • (Boolean) —
    true - 同値
    false - 非同値 


1145
1146
1147
1148
1149
 
# File 'lib/when_exe/tmobjects.rb', line 1145

def ==(other)
  (self <=> other) == 0
rescue
  false
end

#[](index) ⇒ Numeric

要素の参照

Parameters:

  • index (Numeric) —

    When::Coordinates で定義している分解能定数に対応する列挙型( YEAR, … , SECOND)

Returns:



989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/when_exe/tmobjects.rb', line 989

def [](index)
  if index == WEEK
    return nil unless @week
    return @week[0]
  elsif index <= 0
    return nil unless @date
    return @date[index-1]
  else
    return nil unless @time
    return @time[index]
  end
end

#days ⇒ String

期間に含まれる日数を示す

Returns:



1041
1042
1043
1044
 
# File 'lib/when_exe/tmobjects.rb', line 1041

def days
  return nil unless @date
  return @date[DAY-1].to_s
end

#designator ⇒ String

持続期間であることを文字‘P’で示す

Returns:



1006
1007
1008
 
# File 'lib/when_exe/tmobjects.rb', line 1006

def designator
  return 'P'
end

#hours ⇒ String

期間に含まれる時間数を示す

Returns:



1059
1060
1061
1062
 
# File 'lib/when_exe/tmobjects.rb', line 1059

def hours
  return nil unless @time
  return @time[HOUR].to_s
end

#minutes ⇒ String

期間に含まれる分数を示す

Returns:



1068
1069
1070
1071
 
# File 'lib/when_exe/tmobjects.rb', line 1068

def minutes
  return nil unless @time
  return @time[MINUTE].to_s
end

#months ⇒ String

期間に含まれる月数を示す

Returns:



1023
1024
1025
1026
 
# File 'lib/when_exe/tmobjects.rb', line 1023

def months
  return nil unless @date
  return @date[MONTH-1].to_s
end

#seconds ⇒ String

期間に含まれる秒数を示す

Returns:



1077
1078
1079
1080
 
# File 'lib/when_exe/tmobjects.rb', line 1077

def seconds
  return nil unless @time
  return @time[SECOND].to_s
end

#sign ⇒ Integer

符号

Returns:

  • (Integer) —

    0 との比較により、負,0,正の値を返す



1099
1100
1101
1102
1103
1104
 
# File 'lib/when_exe/tmobjects.rb', line 1099

def sign
 ((@week || @date || []) + (@time || [])).each do |v|
   return -1 if +v < 0
 end
 return +1
end

#time_indicator ⇒ String Also known as: timeIndicator

期間が1日より短い時間単位を含むとき文字‘T’で示す

Returns:



1050
1051
1052
 
# File 'lib/when_exe/tmobjects.rb', line 1050

def time_indicator
  return (@time) ? 'T' : nil
end

#to_period_duration ⇒ When::TM::PeriodDuration

When::TM::PeriodDuration への変換

Returns:



1229
1230
1231
 
# File 'lib/when_exe/tmobjects.rb', line 1229

def to_period_duration
  self.dup
end

#to_s ⇒ String

文字列化

Returns:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/when_exe/tmobjects.rb', line 1202

def to_s
  period = 'P'
  if @week
    period += @week[0].abs.to_s + 'W'
    period += @week[1].abs.to_s + 'D' unless @week[1] == 0
  elsif @date
    (-@date.length..-1).each do |i|
      period += @date[i].abs.to_s + PRECISION_NAME[i+1][0..0] unless @date[i] == 0
    end
  end
  if @time
    period += 'T'
    (1..@time.length-1).each do |i|
      period += @time[i].abs.to_s + PRECISION_NAME[i][0..0] unless @time[i] == 0
    end
  end
  period = '-' + period if sign < 0
  period == 'P' ? 'P0D' : period
end

#weeks ⇒ String

期間に含まれる週数を示す

Returns:



1032
1033
1034
1035
 
# File 'lib/when_exe/tmobjects.rb', line 1032

def weeks
  return nil unless @week
  return @week[0].to_s
end

#years ⇒ String

期間に含まれる年数を示す

Returns:



1014
1015
1016
1017
 
# File 'lib/when_exe/tmobjects.rb', line 1014

def years
  return nil unless @date
  return @date[YEAR-1].to_s
end