Automatic generation produced by ISE Eiffel
note description: "Absolute times" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2020-05-19 06:45:25 -0800 (Tue, 19 May 2020) $" revision: "$Revision: 104270 $" access: time eis: "name=Obtaining a DATE from a DATE_TIME and vice versa", "src=$(ISE_DOC_UUID)/195849fc-1a9c-d734-2d2b-acae78133886#Obtaining_a_DATE_from_a_DATE_TIME_and_vice_versa", "tag=EiffelTime" class interface TIME create make (h, m, s: INTEGER_32) -- Set hour, minute' and `second` to h, m, s respectively. require correct_time: is_correct_time (h, m, s.to_double, False) ensure hour_set: hour = h minute_set: minute = m second_set: second = s fractional_second_set: fractional_second = 0.to_double make_fine (h, m: INTEGER_32; s: REAL_64) -- Set hour, minute' and `second` to h, m and truncated to -- integer part of s respectively. -- Set `fractional_second` to the fractional part of s. require correct_time: is_correct_time (h, m, s, False) ensure hour_set: hour = h minute_set: minute = m fine_second_set: fine_second = s make_now -- Set current time according to timezone. make_now_utc -- Set the current object to today's date in utc format. make_by_seconds (sec: INTEGER_32) -- Set the object by the number of seconds sec from midnight. require s_large_enough: sec >= 0 s_small_enough: sec < Seconds_in_day ensure seconds_set: seconds = sec make_by_fine_seconds (sec: REAL_64) -- Set the object by the number of seconds sec. require s_large_enough: sec >= 0.to_double s_small_enough: sec < Seconds_in_day.to_double make_from_string (s: READABLE_STRING_8; code: READABLE_STRING_8) -- Initialize from a "standard" string of form -- code. require s_exists: s /= Void c_exists: code /= Void time_valid: time_valid (s, code) make_from_string_default (s: READABLE_STRING_8) -- Initialize from a "standard" string of form -- `default_format_string`. require s_exists: s /= Void time_valid: time_valid (s, default_format_string) make_by_compact_time (c_t: INTEGER_32) -- Initialize from `compact_time`. require c_t_valid: compact_time_valid (c_t) ensure compact_time_set: compact_time = c_t feature -- Initialization make (h, m, s: INTEGER_32) -- Set hour, minute' and `second` to h, m, s respectively. require correct_time: is_correct_time (h, m, s.to_double, False) ensure hour_set: hour = h minute_set: minute = m second_set: second = s fractional_second_set: fractional_second = 0.to_double make_by_compact_time (c_t: INTEGER_32) -- Initialize from `compact_time`. require c_t_valid: compact_time_valid (c_t) ensure compact_time_set: compact_time = c_t make_by_fine_seconds (sec: REAL_64) -- Set the object by the number of seconds sec. require s_large_enough: sec >= 0.to_double s_small_enough: sec < Seconds_in_day.to_double make_by_seconds (sec: INTEGER_32) -- Set the object by the number of seconds sec from midnight. require s_large_enough: sec >= 0 s_small_enough: sec < Seconds_in_day ensure seconds_set: seconds = sec make_fine (h, m: INTEGER_32; s: REAL_64) -- Set hour, minute' and `second` to h, m and truncated to -- integer part of s respectively. -- Set `fractional_second` to the fractional part of s. require correct_time: is_correct_time (h, m, s, False) ensure hour_set: hour = h minute_set: minute = m fine_second_set: fine_second = s make_from_string (s: READABLE_STRING_8; code: READABLE_STRING_8) -- Initialize from a "standard" string of form -- code. require s_exists: s /= Void c_exists: code /= Void time_valid: time_valid (s, code) make_from_string_default (s: READABLE_STRING_8) -- Initialize from a "standard" string of form -- `default_format_string`. require s_exists: s /= Void time_valid: time_valid (s, default_format_string) make_now -- Set current time according to timezone. make_now_utc -- Set the current object to today's date in utc format. feature -- Access compact_time: INTEGER_32 -- Hour, minute, second coded. -- (from TIME_VALUE) Date_time_tools: DATE_TIME_TOOLS -- Tools for outputting dates and times in different formats -- (from TIME_UTILITY) default_format_string: STRING_8 -- Default output format string -- (from TIME_UTILITY) fine_second: REAL_64 -- Representation of second with decimals -- (from TIME_VALUE) fractional_second: REAL_64 -- Fractional part of `fine_second` -- (from TIME_VALUE) generating_type: TYPE [detachable TIME] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty hour: INTEGER_32 -- Hour of the current time -- (from TIME_VALUE) Hours_in_day: INTEGER_32 = 24 -- Number of hours in a day -- (from TIME_CONSTANTS) micro_second: INTEGER_32 -- Microsecond of the current time -- (from TIME_VALUE) milli_second: INTEGER_32 -- Millisecond of the current time -- (from TIME_VALUE) minute: INTEGER_32 -- Minute of the current time -- (from TIME_VALUE) Minutes_in_hour: INTEGER_32 = 60 -- Number of minutes in an hour -- (from TIME_CONSTANTS) nano_second: INTEGER_32 -- Nanosecond of the current time -- (from TIME_VALUE) Origin: TIME -- Origin time ensure -- from ABSOLUTE result_exists: Result /= Void second: INTEGER_32 -- Second of the current time -- (from TIME_VALUE) Seconds_in_day: INTEGER_32 = 86400 -- Number of seconds in an hour -- (from TIME_CONSTANTS) Seconds_in_hour: INTEGER_32 = 3600 -- Number of seconds in an hour -- (from TIME_CONSTANTS) Seconds_in_minute: INTEGER_32 = 60 -- Number of seconds in a minute -- (from TIME_CONSTANTS) time_default_format_string: STRING_8 -- Default output format for times -- (from TIME_CONSTANTS) feature -- Measurement duration: TIME_DURATION -- Duration elapsed from midnight require -- from ABSOLUTE True ensure then seconds_large_enough: Result.seconds_count >= 0 seconds_small_enough: Result.seconds_count < Seconds_in_day fine_seconds: REAL_64 -- Number of seconds and fractions of seconds elapsed from midnight seconds: INTEGER_32 -- Number of seconds elapsed from midnight ensure result_definition: Result = duration.seconds_count feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: TIME): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: TIME): BOOLEAN -- Is other attached to an object of the same type -- as current object and identical to it? -- (from COMPARABLE) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result ensure then -- from COMPARABLE trichotomy: Result = (not (Current < other) and not (other < Current)) is_greater alias ">" (other: TIME): BOOLEAN -- Is current object greater than other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other < Current) is_greater_equal alias ">=" alias "≥" (other: TIME): BOOLEAN -- Is current object greater than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = (other <= Current) is_less alias "<" (other: like Current): BOOLEAN -- Is the current time before other? require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE asymmetric: Result implies not (other < Current) is_less_equal alias "<=" alias "≤" (other: TIME): BOOLEAN -- Is current object less than or equal to other? -- (from COMPARABLE) require -- from PART_COMPARABLE other_exists: other /= Void ensure then -- from COMPARABLE definition: Result = ((Current < other) or (Current ~ other)) max alias "∨" (other: TIME): TIME -- The greater of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_smaller: Current >= other implies Result = Current other_if_smaller: Current < other implies Result = other min alias "∧" (other: TIME): TIME -- The smaller of current object and other -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE current_if_not_greater: Current <= other implies Result = Current other_if_greater: Current > other implies Result = other frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: TIME): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) three_way_comparison alias "⋚" (other: TIME): INTEGER_32 -- If current object equal to other, 0; -- if smaller, -1; if greater, 1 -- (from COMPARABLE) require -- from COMPARABLE other_exists: other /= Void ensure -- from COMPARABLE equal_zero: (Result = 0) = (Current ~ other) smaller_negative: (Result = -1) = (Current < other) greater_positive: (Result = 1) = (Current > other) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Element change set_fine_second (s: REAL_64) -- Set `fine_second` to s -- (from TIME_VALUE) require -- from TIME_MEASUREMENT s_large_enough: s >= 0.to_double s_small_enough: s < Seconds_in_minute.to_double ensure -- from TIME_MEASUREMENT fine_second_set: fine_second = s set_fractionals (f: REAL_64) -- Set `fractional_second` to f. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT f_large_enough: f >= 0.to_double f_small_enough: f < 1.to_double ensure -- from TIME_MEASUREMENT second_same: second = old second set_hour (h: INTEGER_32) -- Set `hour` to h. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT h_large_enough: h >= 0 h_small_enough: h < Hours_in_day ensure -- from TIME_MEASUREMENT hour_set: hour = h set_minute (m: INTEGER_32) -- Set `minute` to m. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT m_large_enough: m >= 0 m_small_enough: m < Minutes_in_hour ensure -- from TIME_MEASUREMENT minute_set: minute = m set_second (s: INTEGER_32) -- Set `second` to s. -- (from TIME_VALUE) require -- from TIME_MEASUREMENT s_large_enough: s >= 0 s_small_enough: s < Seconds_in_minute ensure -- from TIME_MEASUREMENT second_set: second = s feature -- Duplication copy (other: TIME) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: TIME) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: TIME -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: TIME) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: TIME -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: TIME -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable TIME -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) div (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + 1) if i negative -- (from TIME_UTILITY) ensure -- from TIME_UTILITY result_definition: i = j * Result + mod (i, j) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class fine_second_add (f: REAL_64) -- Add f seconds to the current time. -- if f has decimals, `fractional_second` is modified. hour_add (h: INTEGER_32) -- Add h hours to the current object. hour_back -- Move to evious hour. hour_forth -- Move to next hour. minus alias "-" (other: TIME): INTERVAL [TIME] -- Interval between current object and other. -- (from ABSOLUTE) require -- from ABSOLUTE other_exists: other /= Void other_smaller_than_current: other <= Current ensure -- from ABSOLUTE result_exists: Result /= Void result_set: Result.start_bound.is_equal (other) and then Result.end_bound.is_equal (Current) minute_add (m: INTEGER_32) -- Add m minutes to the current object. minute_back -- Move to evious minute. minute_forth -- Move to next minute. mod (i, j: INTEGER_32): INTEGER_32 -- (i \\ j) if i positive -- (i \\ j + j) if i negative -- (from TIME_UTILITY) ensure -- from TIME_UTILITY positive_result: Result >= 0 result_definition: i = j * div (i, j) + Result plus alias "+" (t: TIME_DURATION): TIME -- Sum of the current time and duration t require t_exists: t /= Void ensure result_exists: Result /= Void relative_duration (other: like Current): TIME_DURATION -- Duration elapsed from other to Current require -- from ABSOLUTE other_exists: other /= Void ensure -- from ABSOLUTE result_exists: Result /= Void second_add (s: INTEGER_32) -- Add s seconds to the current time. second_back -- Move to previous second. second_forth -- Move to next second. feature -- Output debug_output: STRING_8 -- Printable representation of time with "standard" -- Form: `time_default_format_string` -- Was declared in {TIME} as synonym of `out`. ensure -- from DEBUG_OUTPUT result_not_void: Result /= Void formatted_out (s: READABLE_STRING_8): STRING_8 -- Printable representation of time with "standard" -- Form: s require s_exists: s /= Void Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- Printable representation of time with "standard" -- Form: `time_default_format_string` -- Was declared in {TIME} as synonym of `debug_output`. ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Preconditions compact_time_valid (c_t: INTEGER_32): BOOLEAN -- Is compact time c_t valid? -- (from TIME_VALIDITY_CHECKER) is_correct_time (h, m: INTEGER_32; s: REAL_64; twelve_hour_scale: BOOLEAN): BOOLEAN -- Is time represented by h, m, code, and s correct? -- twelve_hour_scale specifies if the hour range is 1 - 12 -- (if True) or 0 - 23 (if False). -- (from TIME_VALIDITY_CHECKER) time_valid (s: READABLE_STRING_8; code_string: READABLE_STRING_8): BOOLEAN -- Is the code_string enough precise -- to create an instance of type TIME? -- And does the string s correspond to code_string? -- (from TIME_VALIDITY_CHECKER) require -- from TIME_VALIDITY_CHECKER s_exists: s /= Void code_exists: code_string /= Void invariant second_large_enough: second >= 0 second_small_enough: second < Seconds_in_minute fractionals_large_enough: fractional_second >= 0.to_double fractionals_small_enough: fractional_second < 1.to_double minute_large_enough: minute >= 0 minute_small_enough: minute < Minutes_in_hour hour_large_enough: hour >= 0 hour_small_enough: hour < Hours_in_day -- from COMPARABLE irreflexive_comparison: not (Current < Current) -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class TIME -- Generated by Eiffel Studio --
For more details: eiffel.org