OpenSceneGraph/doc/doc++/osg/TestGraph.html
2003-04-17 16:22:51 +00:00

78 lines
3.9 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class SG_EXPORT osgUtx::TestGraph</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.10">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class SG_EXPORT <A HREF="#DOC.DOCU">osgUtx::TestGraph</A></H2></H2><BLOCKQUOTE> TestGraph is a singleton providing central access to the tree of tests; primarily, it provides access to the root suite</BLOCKQUOTE>
<HR>
<DL>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static <!1><A HREF="TestGraph.html">TestGraph</A>&amp; <B><A HREF="#DOC.164.10.1">instance</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="TestSuite.html">TestSuite</A>* <B><A HREF="#DOC.164.10.2">root</A></B>()
<DD><I> </I>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="TestSuite.html">TestSuite</A>* <B><A HREF="#DOC.164.10.3">suite</A></B>(const std::string&amp; path, <!1><A HREF="TestSuite.html">TestSuite</A>* tsuite = 0, bool createIfNecessary = false)
<DD><I> A utility function for accessing an arbitrary quite by pathname, relative to the suite 'tsuite' (defaults to root if null), and with the option of creating the \em TestSuite designated by \em path, if it does not already exist.</I>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<BLOCKQUOTE>
TestGraph is a singleton providing central access to the tree of tests;
primarily, it provides access to the root suite</BLOCKQUOTE>
<DL>
<A NAME="instance"></A>
<A NAME="DOC.164.10.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static <!1><A HREF="TestGraph.html">TestGraph</A>&amp; instance()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="root"></A>
<A NAME="DOC.164.10.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="TestSuite.html">TestSuite</A>* root()</B></TT>
<DD>
<DL><DT><DT><B>Returns:</B><DD> a pointer to the root TestSuite.<BR><DD></DL><P>
<A NAME="suite"></A>
<A NAME="DOC.164.10.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="TestSuite.html">TestSuite</A>* suite(const std::string&amp; path, <!1><A HREF="TestSuite.html">TestSuite</A>* tsuite = 0, bool createIfNecessary = false)</B></TT>
<DD>
A utility function for accessing an arbitrary quite by pathname, relative to
the suite 'tsuite' (defaults to root if null), and with the option of creating
the \em TestSuite designated by \em path, if it does not already exist.
<P>This method may return 0 if the suite either cannot be found (and createIfNecssary
is 0), or the first component of \em path is not the same as the name of the
TestSuite \em tsuite.
<P>This was written to aid the auto-registration of tests at specific points in
the test tree, where the tests' AutoRegistrationAgents may be distributed across
several files, and cannot be guaranteed to run in a given order. E.g. You cannot
register a test "root.osg.MyTest" unless you know that the the suite "root.osg"
already exists.
<P>
<DL><DT><DT><B>Parameters:</B><DD><B>path</B> - The <!1><A HREF="Test.html#DOC.164.1.3">name</A> of the <!1><A HREF="TestSuite.html">TestSuite</A> to return.
<BR><B>tsuite</B> - The <!1><A HREF="TestGraph.html#DOC.164.10.3">suite</A> to '<!1><A HREF="TestRecord.html#DOC.164.13.1">start</A> from'. Path is relative to this
<!1><A HREF="TestGraph.html#DOC.164.10.3">suite</A> (defaults to <!1><A HREF="TestGraph.html#DOC.164.10.2">root</A> <!1><A HREF="TestGraph.html#DOC.164.10.3">suite</A>).
<BR><B>createIfNecessary</B> - Optionally create the <!1><A HREF="TestSuite.html">TestSuite</A>(<!1><A HREF="ImpostorSprite.html#DOC.2.83.24">s</A>) denoted by path if
they do not exist.<BR><DD></DL><P></DL>
<HR><DL><DT><B>This class has no child classes.</B></DL>
<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
<BR>
This page was generated with the help of <A HREF="http://docpp.sourceforge.net">DOC++</A>.
</BODY>
</HTML>