# Datenwerk / include / datenwerkpp / item_float.hpp

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 /* Copyright (C) 2011 by Leonard Ritter Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef __DATENWERKPP_FLOAT_HPP__ #define __DATENWERKPP_FLOAT_HPP__ namespace dwk { /** @addtogroup float Float * Float items hold double precision (64-bit) floating point values. * @{ */ class Float : public Item { public: enum { class_type = item_type_float }; Float(const Item &item); /** Create a new Float item. * * @param value The value to initialize the new item with. */ Float(double value); /** Get the value of a float. * * Returns the value currently held by this item. * * @return The currently held float value. */ double get(); /** Assign a value to a float. * * Discards the previously stored value and copies \p value to the local store. * * @param value The float value that will be copied. */ void set(double value); /** Get the float_set signal. * * The float_set signal will be emitted when \ref set is called on * this item. Connected callbacks will be passed an event of type * \ref EventFloatSet with context information. Note that the event * will be sent _before_ the value is ultimately assigned, so a call to * \ref get will still yield the old value. * * @return The float_set signal. */ Signal get_signal_set(); }; /** Event structure passed to callbacks connected to the signals returned by * \ref Float::get_signal_set. */ struct EventFloatSet : Event { /** The value passed to \ref Float::set. */ double value; }; /** @} */ // end of float group } // namespace dwk #endif // __DATENWERKPP_FLOAT_HPP__