API Tree - Revision history

MartinW: /* Examples */

2024-10-17T08:27:44Z

Examples

BenR at 11:58, 10 February 2016

2016-02-10T11:58:46Z

JonnyW: XML import

2014-01-16T15:58:02Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:49Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:57:53Z

XML import of updated API docs

JonnyW: XML import API changes

2013-05-14T12:21:24Z

XML import API changes

Admin: XML import

2013-05-11T22:10:42Z

XML import

Admin: XML import

2013-05-11T21:24:06Z

XML import

Admin: XML import

2013-05-11T17:37:12Z

XML import

Admin: XML import API auto-gen

2013-05-10T15:35:02Z

XML import API auto-gen

@@ Line 78: / Line 78: @@
 ==Examples==
-Here is an example program to step through the components in the current project and count the number of 5mm LEDs in the project.
+Here is an example program to step through the components in the current project and count the number of LEDs in the project.
 We begin by initialising the traversal handle to this which is the root of the panel.
@@ Line 86: / Line 86: @@
 The Tree.GetName function allows us to collect the name of the component the handle variable is currently pointing to.
-If the name matches the string "led_5mm" then we increment the counter to count the number of LED components.
+If the name matches the string "LEDMono" then we increment the counter to count the number of LED components.
 {{Fcfile|CountComponent.fcfx|Tree Traverse Demo}}
 ==See also==
 ''<span style="color:red;">No additional information</span>''

@@ Line 77: / Line 77: @@
 ==Examples==
-''<span style="color:red;">No additional examples</span>''
 ==See also==
 ''<span style="color:red;">No additional information</span>''

← Older revision		Revision as of 15:58, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Data-tree traversal type routines		Data-tree traversal type routines

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Data-tree traversal type routines		Data-tree traversal type routines

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Data-tree traversal type routines
@@ Line 77: / Line 79: @@
 ==Examples==
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''
 ==See also==
 ''<span style="color:red;">No additional information</span>''

@@ Line 2: / Line 2: @@
 Data-tree traversal type routines
-===Functions provided for this class===
+==Functions provided for this class==
-{||-|[[API Tree.GetValue|GetValue]]|Gets the value of the given object, if available|-|[[API Tree.GetName|GetName]]|Gets the name of the given object|-|[[API Tree.GetPath|GetPath]]|Gets the full '.' separated name of the given object|-|[[API Tree.GetSubValue|GetSubValue]]|Gets the value of a named sub-item of the given object, if available|-|[[API Tree.Traverse|Traverse]]|Updates the object to step depth-first through the tree|-|[[API Tree.StepNext|StepNext]]|Updates the object to point to the next (younger) sibling|-|[[API Tree.StepNamedNext|StepNamedNext]]|Updates the object to point to the next (younger) sibling matching the name|-|[[API Tree.StepNamedIndex|StepNamedIndex]]|Updates the object to point to the Nth next (younger) sibling matching the name|-|[[API Tree.StepLast|StepLast]]|Updates the object to point to the last (elder) sibling|-|[[API Tree.StepParent|StepParent]]|Updates the object to point to its parent object|-|[[API Tree.StepRoot|StepRoot]]|Updates the object to point to the root of the tree|-|[[API Tree.StepChildHead|StepChildHead]]|Updates the object to point to the head (eldest) child|-|[[API Tree.StepChildTail|StepChildTail]]|Updates the object to point to the tail (youngest) child|-|[[API Tree.StepChildPath|StepChildPath]]|Updates the object to point to the '.' separated named child path|-|[[API Tree.CountChildren|CountChildren]]|Returns the number of immediate children present for the object|-|[[API Tree.CheckChildren|CheckChildren]]|Returns true if the object has children, else false|-|[[API Tree.CountNamedChildren|CountNamedChildren]]|Returns the number of immediate children present for the object|-|[[API Tree.CheckParent|CheckParent]]|Returns true if the object has a parent, else false if it is the root|-|[[API Tree.StepSubHead|StepSubHead]]|Updates the object to point to the head (eldest) attribute, if any|-|[[API Tree.StepSubTail|StepSubTail]]|Updates the object to point to the tail (youngest) attribute, if any|-|[[API Tree.StepSubName|StepSubName]]|Updates the object to point to the named attribute, if any|-|[[API Tree.GetCopy|GetCopy]]|Creates a copy of the handle and returns the copy|}
+{|
-===Examples===

← Older revision		Revision as of 15:35, 10 May 2013
Line 1:		Line 1:
−	~~wiki page name~~	+	<sidebar>API contents</sidebar>
	Data-tree traversal type routines		Data-tree traversal type routines