OpenSceneGraph/doc/doc++/osg/TestGraph.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.6">
</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.246.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.246.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.246.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.246.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.246.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.246.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.246.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.246.10.3">suite</A> to '<!1><A HREF="TestRecord.html#DOC.246.13.1">start</A> from'. Path is relative to this
<!1><A HREF="TestGraph.html#DOC.246.10.3">suite</A> (defaults to <!1><A HREF="TestGraph.html#DOC.246.10.2">root</A> <!1><A HREF="TestGraph.html#DOC.246.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.124.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://www.linuxsupportline.com/~doc++">DOC++</A>.
</BODY>
</HTML>
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">`

			`<HTML>`
			`<HEAD>`
			`<TITLE>class SG_EXPORT osgUtx::TestGraph</TITLE>`
Updated docs 2004-08-06 14:53:36 +08:00			`<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`</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>`
Updated docs 2004-08-06 14:53:36 +08:00			`<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>static <!1><A HREF="TestGraph.html">TestGraph</A>& <B><A HREF="#DOC.246.10.1">instance</A></B>()`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<DT>`
Updated docs 2004-08-06 14:53:36 +08:00			`<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="TestSuite.html">TestSuite</A>* <B><A HREF="#DOC.246.10.2">root</A></B>()`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<DD><I> </I>`
			`<DT>`
Updated docs 2004-08-06 14:53:36 +08:00			`<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="TestSuite.html">TestSuite</A>* <B><A HREF="#DOC.246.10.3">suite</A></B>(const std::string& path, <!1><A HREF="TestSuite.html">TestSuite</A>* tsuite = 0, bool createIfNecessary = false)`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<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>`
Updated docs 2004-08-06 14:53:36 +08:00			`<A NAME="DOC.246.10.1"></A>`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>static <!1><A HREF="TestGraph.html">TestGraph</A>& instance()</B></TT>`
			`<DL><DT><DD></DL><P>`
			`<A NAME="root"></A>`
Updated docs 2004-08-06 14:53:36 +08:00			`<A NAME="DOC.246.10.2"></A>`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<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>`
Updated docs 2004-08-06 14:53:36 +08:00			`<A NAME="DOC.246.10.3"></A>`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="TestSuite.html">TestSuite</A>* suite(const std::string& 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>`

Updated docs 2004-08-06 14:53:36 +08:00			`<DL><DT><DT><B>Parameters:</B><DD><B>path</B> - The <!1><A HREF="Test.html#DOC.246.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.246.10.3">suite</A> to '<!1><A HREF="TestRecord.html#DOC.246.13.1">start</A> from'. Path is relative to this`
			`<!1><A HREF="TestGraph.html#DOC.246.10.3">suite</A> (defaults to <!1><A HREF="TestGraph.html#DOC.246.10.2">root</A> <!1><A HREF="TestGraph.html#DOC.246.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.124.24">s</A>) denoted by path if`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`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>`
Updated docs 2004-08-06 14:53:36 +08:00			`This page was generated with the help of <A HREF="http://www.linuxsupportline.com/~doc++">DOC++</A>.`
Added doc++ documentation. 2003-04-18 00:22:51 +08:00			`</BODY>`
			`</HTML>`