The wiki at wiki.Tekkotsu.org
contains lots of information about individual robot types, the
Tekkotsu framework, demo programs, robot maze construction, and more.
How to Use the Tekkotsu Reference Pages
From the gray navigation bar at the top of any Tekkotsu.org web page,
click on Reference to visit the reference section. You will see
a directory of choices at the top, with tabs such as NameSpaces,
Classes, and Files, and a little navigation frame running vertically
down the left hand side. These perform similar functions.
To look up a class: Click on the "Classes" tab and you
will see a compact alphabetical list of all classes in the main
Tekkotsu namespace. Click on the "Class List" sub-tab, or "Class
List" in the left navigation frame, to call up a more detailed listing
of all Tekkotsu classes with brief descriptions. Try clicking on the
"BehaviorBase" class to view its documentation. Note that the
documentation includes an inheritance diagram showing the parents and
children of BehaviorBase. These are also clickable.
To browse classes: In the navigation frame at left, click
on the "+" sign or the little folder icon next to "Class List". This
opens up the list of classes so you can scroll around and click on any
item. Click on "EventBase"; that item will be displayed in the main
frame. You can continue to click on items in the navigation frame to
jump to different items in the list. Click on the "-" sign or the
folder icon to close the "Class List" folder.
To browse classes from the main frame, click on the "Alphabetical
List" tab under "Classes". This displays a compact alphabetical list
of just the class names, while "Class List" includes short
descriptions.
To look up a class member: Click on "Class Members" under the
Classes tab at the top of the main page, or "Class Members" in
the navigation frame at left; this will take you to the "Class Members
- All" tab. Using the expanded menu at the top of the main frame,
you can restrict the listing to a certain type of class member
(Functions, Variables, Typedefs, Enumerations, etc.), or jump to a
specific letter in the alphabetical listing.
Select the "a" listing and scroll down to "addListener()", and you'll
see that it's a member of the class EventRouter. Click on its
"EventRouter" link and you will be taken to the documentation for the
addListener() member function within the EventRouter class. To look
up another member, click on "Class Members" in the navigation frame at
left to get back to the class members listing. Then select "b" and
scroll down to "buttonEGID" and click on its "EventBase" link. You
will see that buttonEGID is an enumeration value of type
EventBase::EventGeneratorID_t.
To find a class's parents and children: Click on the
"Class Hierarchy" sub-tab of the Classes tab, or on "Class Hierarchy" in the
left navigation frame, and do a search for the "Transition" class.
Below it you will find all the subclasses of Transition. If you click
on the Transition link you will be taken to the documentation for
Transition, which begins with a graphical depiction of the class, its
immediate parent class(es), and its immediate child classes. Boxes
outlined in red indicate additional levels of the hierarchy have been
suppressed; click on a box to move up or down the hierarchy.
To look at a source file: Click on "File List" in the
Files directory, or "File List" in the navigation frame at left, to
call up a listing of all the Tekkotsu source files and their
descriptions. Or, in the left navigation frame, open the "File List"
folder to just see a list of file names. Either way, clicking on
"BehaviorBase.h" will show you information about that file, including
the dependency gaph that shows its relationships to other files.
Clicking on the "code" link will show you the actual source code, with
nice syntax highlighting. You will also find links to the source file
included in the description of every class member.
To look up namespace info: When you want to look up
information on the various namespaces included in Tekkotsu, click on
the "Namespaces" tab and then the "NameSpace List" sub-tab, or open
the "Namespace List" folder in the left navigation frame, and then
click on the namespace you want to examine. Look at the ChiaraInfo
namespace for information about the Chiara robot configuration, or the
HandEyeInfo namespace if you're using a hand-eye system.
To view the ToDo List or Bug List: Click on the "Related
Pages" tab and then select "To Do" list. The "Bug List" tab is not
useful; bugs are now documented using a Bugzilla database at bugs.Tekkotsu.org.
