OpenSceneGraph/doc/doc++/osgDB/ReadResult.html
Robert Osfield ed10594139 Updated docs
2004-08-06 06:53:36 +00:00

227 lines
10 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>class osgDB::ReaderWriter::ReadResult</TITLE>
<META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
</HEAD>
<BODY BGCOLOR="#ffffff">
<H2>class <A HREF="#DOC.DOCU">osgDB::ReaderWriter::ReadResult</A></H2></H2><HR>
<DL>
<P><DL>
<DT><H3>Public Classes</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>enum <B><A HREF="#DOC.2.39.5.1">ReadStatus</A></B>
</DL></P>
<P><DL>
<DT><H3>Public Methods</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.39.5.2">ReadResult</A></B>(<!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <!1><A HREF="ReadResult.html#DOC.2.39.5.20">status</A>=<!1><A HREF="ReadResult.html#DOC.2.39.5.1.1">FILE_NOT_HANDLED</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.39.5.3">ReadResult</A></B>(const std::string&amp; m)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.39.5.4">ReadResult</A></B>(osg::Object* obj, <!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <!1><A HREF="ReadResult.html#DOC.2.39.5.20">status</A>=<!1><A HREF="ReadResult.html#DOC.2.39.5.1.3">FILE_LOADED</A>)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.39.5.5">ReadResult</A></B>(const <!1><A HREF="ReadResult.html#DOC.2.39.5.5">ReadResult</A>&amp; rr)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ReadResult.html">ReadResult</A>&amp; <B><A HREF="#DOC.2.39.5.6">operator = </A></B>(const <!1><A HREF="ReadResult.html">ReadResult</A>&amp; rr)
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Object* <B><A HREF="#DOC.2.39.5.7">getObject</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Image* <B><A HREF="#DOC.2.39.5.8">getImage</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::HeightField* <B><A HREF="#DOC.2.39.5.9">getHeightField</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Node* <B><A HREF="#DOC.2.39.5.10">getNode</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.11">validObject</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.12">validImage</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.13">validHeightField</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.14">validNode</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Object* <B><A HREF="#DOC.2.39.5.15">takeObject</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Image* <B><A HREF="#DOC.2.39.5.16">takeImage</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::HeightField* <B><A HREF="#DOC.2.39.5.17">takeHeightField</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Node* <B><A HREF="#DOC.2.39.5.18">takeNode</A></B>()
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>const std::string&amp; <B><A HREF="#DOC.2.39.5.19">message</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <B><A HREF="#DOC.2.39.5.20">status</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.21">success</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.22">loadedFromCache</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.23">error</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.24">notHandled</A></B>() const
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>bool <B><A HREF="#DOC.2.39.5.25">notFound</A></B>() const
</DL></P>
<P><DL>
<DT><H3>Protected Fields</H3><DD><DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif><!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <B><A HREF="#DOC.2.39.5.26">_status</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>std::string <B><A HREF="#DOC.2.39.5.27">_message</A></B>
<DT>
<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::ref_ptr&lt;osg::Object&gt; <B><A HREF="#DOC.2.39.5.28">_object</A></B>
</DL></P>
</DL>
<A NAME="DOC.DOCU"></A>
<HR>
<H2>Documentation</H2>
<DL>
<A NAME="ReadStatus"></A>
<A NAME="DOC.2.39.5.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>enum ReadStatus</B></TT>
<DL><DT><DD></DL><P><DL>
<A NAME="FILE_NOT_HANDLED"></A>
<A NAME="DOC.2.39.5.1.1"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> FILE_NOT_HANDLED</B></TT>
<DL><DT><DD></DL><P>
<A NAME="FILE_NOT_FOUND"></A>
<A NAME="DOC.2.39.5.1.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> FILE_NOT_FOUND</B></TT>
<DL><DT><DD></DL><P>
<A NAME="FILE_LOADED"></A>
<A NAME="DOC.2.39.5.1.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> FILE_LOADED</B></TT>
<DL><DT><DD></DL><P>
<A NAME="FILE_LOADED_FROM_CACHE"></A>
<A NAME="DOC.2.39.5.1.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> FILE_LOADED_FROM_CACHE</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ERROR_IN_READING_FILE"></A>
<A NAME="DOC.2.39.5.1.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ERROR_IN_READING_FILE</B></TT>
<DL><DT><DD></DL><P></DL>
<A NAME="ReadResult"></A>
<A NAME="DOC.2.39.5.2"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ReadResult(<!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <!1><A HREF="ReadResult.html#DOC.2.39.5.20">status</A>=<!1><A HREF="ReadResult.html#DOC.2.39.5.1.1">FILE_NOT_HANDLED</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ReadResult"></A>
<A NAME="DOC.2.39.5.3"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ReadResult(const std::string&amp; m)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ReadResult"></A>
<A NAME="DOC.2.39.5.4"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ReadResult(osg::Object* obj, <!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> <!1><A HREF="ReadResult.html#DOC.2.39.5.20">status</A>=<!1><A HREF="ReadResult.html#DOC.2.39.5.1.3">FILE_LOADED</A>)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="ReadResult"></A>
<A NAME="DOC.2.39.5.5"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> ReadResult(const <!1><A HREF="ReadResult.html#DOC.2.39.5.5">ReadResult</A>&amp; rr)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="operator = "></A>
<A NAME="DOC.2.39.5.6"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ReadResult.html">ReadResult</A>&amp; operator = (const <!1><A HREF="ReadResult.html">ReadResult</A>&amp; rr)</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getObject"></A>
<A NAME="DOC.2.39.5.7"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Object* getObject()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getImage"></A>
<A NAME="DOC.2.39.5.8"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Image* getImage()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getHeightField"></A>
<A NAME="DOC.2.39.5.9"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::HeightField* getHeightField()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="getNode"></A>
<A NAME="DOC.2.39.5.10"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Node* getNode()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="validObject"></A>
<A NAME="DOC.2.39.5.11"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool validObject()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="validImage"></A>
<A NAME="DOC.2.39.5.12"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool validImage()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="validHeightField"></A>
<A NAME="DOC.2.39.5.13"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool validHeightField()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="validNode"></A>
<A NAME="DOC.2.39.5.14"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool validNode()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="takeObject"></A>
<A NAME="DOC.2.39.5.15"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Object* takeObject()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="takeImage"></A>
<A NAME="DOC.2.39.5.16"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Image* takeImage()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="takeHeightField"></A>
<A NAME="DOC.2.39.5.17"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::HeightField* takeHeightField()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="takeNode"></A>
<A NAME="DOC.2.39.5.18"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Node* takeNode()</B></TT>
<DL><DT><DD></DL><P>
<A NAME="message"></A>
<A NAME="DOC.2.39.5.19"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>const std::string&amp; message() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="status"></A>
<A NAME="DOC.2.39.5.20"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> status() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="success"></A>
<A NAME="DOC.2.39.5.21"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool success() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="loadedFromCache"></A>
<A NAME="DOC.2.39.5.22"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool loadedFromCache() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="error"></A>
<A NAME="DOC.2.39.5.23"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool error() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="notHandled"></A>
<A NAME="DOC.2.39.5.24"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool notHandled() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="notFound"></A>
<A NAME="DOC.2.39.5.25"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>bool notFound() const </B></TT>
<DL><DT><DD></DL><P>
<A NAME="_status"></A>
<A NAME="DOC.2.39.5.26"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B><!1><A HREF="ReadResult.html#DOC.2.39.5.1">ReadStatus</A> _status</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_message"></A>
<A NAME="DOC.2.39.5.27"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>std::string _message</B></TT>
<DL><DT><DD></DL><P>
<A NAME="_object"></A>
<A NAME="DOC.2.39.5.28"></A>
<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::ref_ptr&lt;osg::Object&gt; _object</B></TT>
<DL><DT><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>