Automatic generation produced by ISE Eiffel
note description: "COM Currency Structure" legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2020-04-15 20:46:39 -0800 (Wed, 15 Apr 2020) $" revision: "$Revision: 104049 $" class interface ECOM_CURRENCY create make make_from_pointer (a_pointer: POINTER) -- Make from pointer. require -- from ECOM_STRUCTURE valid_pointer: a_pointer /= default_pointer make_from_decimal (dec_value: ECOM_DECIMAL) -- Create with value 'dec_value' feature -- Access generating_type: TYPE [ECOM_CURRENCY] -- 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 high_bits: INTEGER_32 -- High 32 bits of currency. item: POINTER -- Generic Windows handle or structure pointer. -- Can be a HWND, HICON, RECT *, WNDCLASS *, etc... -- (from WEL_ANY) low_bits: INTEGER_32 -- Low 32 bits of currency. one: ECOM_CURRENCY -- Neutral element for * operation ensure -- from NUMERIC result_exists: Result /= Void zero: ECOM_CURRENCY -- Neutral element for + operation ensure -- from NUMERIC result_exists: Result /= Void feature -- Measurement structure_size: INTEGER_32 -- Size of CY (CURRENCY) structure. ensure -- from WEL_STRUCTURE positive_result: Result > 0 feature -- Comparison frozen deep_equal (a: 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: 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: ECOM_CURRENCY): 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) frozen standard_equal (a: 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: ECOM_CURRENCY): 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) 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 exists: BOOLEAN -- Does the `item` exist? -- (from WEL_ANY) ensure -- from WEL_ANY Result = (item /= default_pointer) 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)) shared: BOOLEAN -- Is `item` shared by another object? -- If False (by default), `item` will -- be destroyed by `destroy_item`. -- If True, `item` will not be destroyed. -- (from WEL_ANY) feature -- Status setting set_shared -- Set `shared` to True. -- (from WEL_ANY) ensure -- from WEL_ANY shared: shared set_unshared -- Set `shared` to False. -- (from WEL_ANY) ensure -- from WEL_ANY unshared: not shared feature -- Element change set_item (an_item: POINTER) -- Set `item` with an_item -- (from WEL_ANY) ensure -- from WEL_ANY item_set: item = an_item feature -- Removal dispose -- Destroy the inner structure of Current. -- -- This function should be called by the GC when the -- object is collected or by the user if Current is -- no more usefull. -- (from WEL_ANY) feature -- Conversion absolute: ECOM_CURRENCY -- Absolute value of currency ensure valid_result: Result /= Void ceiled_integer_portion: ECOM_CURRENCY -- Integer portion of currency value. The first negative -- integer >= to the value is returned if the value is negative. ensure valid_result: Result /= Void rounded (value: INTEGER_32): ECOM_CURRENCY -- Round value with value decimal places require valid_value: value >= 0 ensure valid_result: Result /= Void truncated_to_double: REAL_64 -- Truncated to DOUBLE require valid_item: item /= default_pointer truncated_to_integer_portion: ECOM_CURRENCY -- Integer portion of a currency value. The first negative integer -- <= to the value is returned if the value is negative. ensure valid_result: Result /= Void feature -- Duplication frozen deep_copy (other: ECOM_CURRENCY) -- 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: ECOM_CURRENCY -- 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: ECOM_CURRENCY) -- 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: ECOM_CURRENCY -- 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: ECOM_CURRENCY -- 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 copy (other: ECOM_CURRENCY) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from WEL_STRUCTURE) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen default: ECOM_CURRENCY -- 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) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class identity alias "+": ECOM_CURRENCY -- Unary plus ensure -- from NUMERIC result_exists: Result /= Void initialize -- Fill Current with zeros. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists initialize_with_character (a_character: CHARACTER_8) -- Fill current with a_character. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE exists: exists memory_copy (source_pointer: POINTER; length: INTEGER_32) -- Copy length bytes from source_pointer to `item`. -- (from WEL_STRUCTURE) require -- from WEL_STRUCTURE length_small_enough: length <= structure_size length_large_enough: length > 0 exists: exists minus alias "-" alias "−" (other: ECOM_CURRENCY): ECOM_CURRENCY -- Subtract with other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void multiply_integer (an_integer: INTEGER_32): ECOM_CURRENCY -- Multiply by an_integer ensure valid_result: Result /= Void opposite alias "-" alias "−": ECOM_CURRENCY -- Negative value of currency ensure -- from NUMERIC result_exists: Result /= Void plus alias "+" (other: ECOM_CURRENCY): ECOM_CURRENCY -- Add with other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void commutative: Result ~ (other + Current) power alias "^" (other: NUMERIC): NUMERIC -- Current objects to the power 'other' product alias "*" alias "×" (other: ECOM_CURRENCY): ECOM_CURRENCY -- Multiply by other require -- from NUMERIC other_exists: other /= Void ensure -- from NUMERIC result_exists: Result /= Void quotient alias "/" alias "÷" (other: ECOM_CURRENCY): ECOM_CURRENCY -- Division by 'other' require -- from NUMERIC other_exists: other /= Void good_divisor: divisible (other) ensure -- from NUMERIC result_exists: Result /= Void feature -- Basic Operations set_value (source: ECOM_CURRENCY) -- Set Current to 'source'. -- (from ECOM_STRUCTURE) require -- from ECOM_STRUCTURE non_void: source /= Void valid_source: source.item /= default_pointer feature -- Element Change set_high_bits (an_integer: INTEGER_32) -- Set `high_bits` with an_integer. ensure high_bits_set: high_bits = an_integer set_low_bits (an_integer: INTEGER_32) -- Set 'low_bits' with 'an_integer'. ensure low_bits_set: low_bits = an_integer feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: 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 -- status report divisible (other: ECOM_CURRENCY): BOOLEAN -- Is divisible by other? require -- from NUMERIC other_exists: other /= Void exponentiable (other: ECOM_CURRENCY): BOOLEAN -- Is exponentiable by other? require -- from NUMERIC other_exists: other /= Void is_equal (other: like Current): BOOLEAN -- Is 'other' the same as Current object? require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result invariant -- 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 ECOM_CURRENCY -- Generated by Eiffel Studio --
For more details: eiffel.org