ObjectId (Object function) - Revision history

Mmarshall at 07:49, 25 May 2015

2015-05-25T07:49:40Z

← Older revision		Revision as of 07:49, 25 May 2015
Line 12:		Line 12:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>As noted above, the ~~aboject~~ ids are unique in an Online. However, they are not unique between Onlines nor between runs of an Online.</li>		<li>As noted above, the object ids are unique in an Online. However, they are not unique between Onlines nor between runs of an Online.</li>
	<li>The object ids are assigned in numeric order starting at 1. So the first object instantiated in an Online run has object id 1, the second has object id 2, and so on. Since the object ids are online-wide, there is no guarantee that an object instantiated right after another object in the same request will have an object id one greater than the previous one's. This is because other objects for other threads (users) might instantiate an object between the two instantiations in the request.</li>		<li>The object ids are assigned in numeric order starting at 1. So the first object instantiated in an Online run has object id 1, the second has object id 2, and so on. Since the object ids are online-wide, there is no guarantee that an object instantiated right after another object in the same request will have an object id one greater than the previous one's. This is because other objects for other threads (users) might instantiate an object between the two instantiations in the request.</li>
	<li>The id is a characteristic of the object, not the object variable. As such, the same value is returned for a given object, regardless of what variable is used to obtain the id and regardless of the class of the variable used to invoke the <var>Objectid</var> method (base class or extension class).</li>		<li>The id is a characteristic of the object, not the object variable. As such, the same value is returned for a given object, regardless of what variable is used to obtain the id and regardless of the class of the variable used to invoke the <var>Objectid</var> method (base class or extension class).</li>

Alex: /* Examples */

2012-07-16T05:24:28Z

Examples

← Older revision		Revision as of 05:24, 16 July 2012
Line 20:		Line 20:
	The <var>ObjectId</var> function can be useful in creating temporary object-specific references to other objects. For example, suppose you have <var>Widget</var> and <var>Box</var> objects in an application. The <var>Widget</var> objects do not contain references to <var>Box</var> objects because boxes don't have much to do with widgets. However, in our specific application, we are tracking widgets in boxes so it would be very useful to be able to get a <var>Box</var> object from a <var>Widget</var> object. To accomplish this, we first declare a [[FloatNamedArraylist_class\|FloatNamedArraylist]] of <var>Box</var> objects:<p class="code">%widgetBox is floatNamedArraylist of object box		The <var>ObjectId</var> function can be useful in creating temporary object-specific references to other objects. For example, suppose you have <var>Widget</var> and <var>Box</var> objects in an application. The <var>Widget</var> objects do not contain references to <var>Box</var> objects because boxes don't have much to do with widgets. However, in our specific application, we are tracking widgets in boxes so it would be very useful to be able to get a <var>Box</var> object from a <var>Widget</var> object. To accomplish this, we first declare a [[FloatNamedArraylist_class\|FloatNamedArraylist]] of <var>Box</var> objects:<p class="code">%widgetBox is floatNamedArraylist of object box
	</p>		</p>
	The idea is that the collection "names" will be the <var>Widget</var> object~~'s id~~. Now, whenever a widget it put into a box or determined to be in a box, we assign that <var>Box</var> object variable to the FloatNamedArraylist item with the <var>Widget</var>'s object id:<p class="code">%widgetBox(%widget:objectId) = %box		The idea is that the collection "names" will be the <var>Widget</var> object ids. Now, whenever a widget is put into a box or determined to be in a box, we assign that <var>Box</var> object variable to the FloatNamedArraylist item with the <var>Widget</var>'s object id:<p class="code">%widgetBox(%widget:objectId) = %box
	</p>		</p>
	If a <var>Widget</var> is moved to a different <var>Box</var> its <var>WidgetBox</var> item must be set to point to the new <var>Box</var>. With this in place, it becomes very easy to access the correct <var>Box</var> object, given a <var>Widget</var> object:<p class="code">%box = %widgetBox(%~~wdget~~:objectId)		If a <var>Widget</var> is moved to a different <var>Box</var> its <var>WidgetBox</var> item must be set to point to the new <var>Box</var>. With this in place, it becomes very easy to access the correct <var>Box</var> object, given a <var>Widget</var> object:<p class="code">%box = %widgetBox(%widget:objectId)
	</p>		</p>

	==See also==		==See also==
	{{Template:Object:ObjectId footer}}		{{Template:Object:ObjectId footer}}

Alex at 05:12, 16 July 2012

2012-07-16T05:12:22Z

← Older revision		Revision as of 05:12, 16 July 2012
Line 1:		Line 1:
	{{Template:Object:ObjectId subtitle}}		{{Template:Object:ObjectId subtitle}}

	This ~~page is [[under construction]]~~.		This function returns a unique numeric id for an object.
	==Syntax==		==Syntax==
	{{Template:Object:ObjectId syntax}}		{{Template:Object:ObjectId syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number</th><td>~~number~~</td></tr>		<tr><th>%number</th><td>Is the online-wide unique id of the object.</td></tr>
	<tr><th>object</th>		<tr><th>object</th>
	<td>Object object</td></tr>		<td>Object object for which id is to be returned. Of course, since all classes extend the <var>Object</var> class, <var>object</var> can be of any class.</td></tr>
	</table>		</table>
	==Usage notes==		==Usage notes==
			<ul>
			<li>As noted above, the aboject ids are unique in an Online. However, they are not unique between Onlines nor between runs of an Online.</li>
			<li>The object ids are assigned in numeric order starting at 1. So the first object instantiated in an Online run has object id 1, the second has object id 2, and so on. Since the object ids are online-wide, there is no guarantee that an object instantiated right after another object in the same request will have an object id one greater than the previous one's. This is because other objects for other threads (users) might instantiate an object between the two instantiations in the request.</li>
			<li>The id is a characteristic of the object, not the object variable. As such, the same value is returned for a given object, regardless of what variable is used to obtain the id and regardless of the class of the variable used to invoke the <var>Objectid</var> method (base class or extension class).</li>
			<li><var>XmlNode</var> objects return the id of the containing <var>XmlDoc</var> object.</li>
			</ul>
	==Examples==		==Examples==
			The <var>ObjectId</var> function can be useful in creating temporary object-specific references to other objects. For example, suppose you have <var>Widget</var> and <var>Box</var> objects in an application. The <var>Widget</var> objects do not contain references to <var>Box</var> objects because boxes don't have much to do with widgets. However, in our specific application, we are tracking widgets in boxes so it would be very useful to be able to get a <var>Box</var> object from a <var>Widget</var> object. To accomplish this, we first declare a [[FloatNamedArraylist_class\|FloatNamedArraylist]] of <var>Box</var> objects:<p class="code">%widgetBox is floatNamedArraylist of object box
			</p>
			The idea is that the collection "names" will be the <var>Widget</var> object's id. Now, whenever a widget it put into a box or determined to be in a box, we assign that <var>Box</var> object variable to the FloatNamedArraylist item with the <var>Widget</var>'s object id:<p class="code">%widgetBox(%widget:objectId) = %box
			</p>
			If a <var>Widget</var> is moved to a different <var>Box</var> its <var>WidgetBox</var> item must be set to point to the new <var>Box</var>. With this in place, it becomes very easy to access the correct <var>Box</var> object, given a <var>Widget</var> object:<p class="code">%box = %widgetBox(%wdget:objectId)
			</p>
	==See also==		==See also==
	{{Template:Object:ObjectId footer}}		{{Template:Object:ObjectId footer}}

Wiccan: Automatically generated page update

2012-07-16T04:44:00Z

Automatically generated page update

New page

{{Template:Object:ObjectId subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Object:ObjectId syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th><td>number</td></tr>
<tr><th>object</th>
<td>Object object</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Object:ObjectId footer}}