Changes between Version 1 and Version 2 of code/doc/MultiType

Timestamp:

Sep 22, 2008, 8:04:42 PM (16 years ago)

Author:

landauf

Comment:

—

code/doc/MultiType

@@ -34 +34 @@
 
 == Usage ==
-It's important to know the MultiType has some sort of an internal type.
+
+=== Assign a value ===
+There are three ways to assign a value to a MultiType:
+ * Constructor: MultiType myMT = 10;
+ * Assignment '''operator=''': MultiType myMT myMT = 10;
+ * '''setValue('''''value''''')''': MultiType myMT myMT.setValue(10);
+
+Important: If you assign a value of a specific type and then assign a new value of another type, the new value will be converted to the first type. Read the [wiki:MultiType#internaltype section below] for detailed information.
+
+=== Retrieve a value ===
+There are four three to retrieve a value from a MultiType:
+ * Implicit conversion: float value = myMT; (or float value = (float)myMT;)
+ * Get by pointer: '''getValue('''''pointer''''')''': float value = 0; myMT.getValue(&value);
+ * Explicit function call: float value = myMT.getFloat().
+
+If the current value of the MultiType has another type, it will be converted to the implicitly or explicitly requested type.
+
+=== Internal type ===
+It's very important to know the MultiType has some sort of an internal type. It's the type of the first assigned value. If you assign another value of another type, it will be converted to the first type. If you don't know about this, you may get many unnecessary conversions. But if you know about it, you can save much CPU time.
+
+Example:
+ * Think about a function, receiving a float, and a MultiType, containing a string. If you want to call the function 100'000 times, you will convert the string every f***ing time into a float. So you better create a MultiType with internal type ''float'' and assign the string afterward. This way the string gets already converted when assigned and you save 99'999 conversions.
+
+But of course you can change this type:
+
+=== Change type ===
+There are three possible ways to change the internal type of a MultiType:
+ * '''setType<'''''type'''''>()''': This changes the type and resets the value.
+ * '''convert<'''''type'''''>()''': This changes the type and converts the current value to the new type.
+ * '''setValue<'''''type'''''>('''''value''''')''': This changes the type and assigns a new value. The new value may be of another value than ''type'', it will be converted.