osgDB::ReaderWriter::ReadResult Class Reference

List of all members.

Public Types
enum	ReadStatus {   FILE_NOT_HANDLED, FILE_NOT_FOUND, FILE_LOADED, FILE_LOADED_FROM_CACHE,   ERROR_IN_READING_FILE, FILE_REQUESTED }
Public Member Functions
	ReadResult (ReadStatus status=FILE_NOT_HANDLED)
	ReadResult (const std::string &m)
	ReadResult (osg::Object *obj, ReadStatus status=FILE_LOADED)
	ReadResult (const ReadResult &rr)
ReadResult &	operator= (const ReadResult &rr)
osg::Object *	getObject ()
osg::Image *	getImage ()
osg::HeightField *	getHeightField ()
osg::Node *	getNode ()
osgDB::Archive *	getArchive ()
osg::Shader *	getShader ()
bool	validObject ()
bool	validImage ()
bool	validHeightField ()
bool	validNode ()
bool	validArchive ()
bool	validShader ()
osg::Object *	takeObject ()
osg::Image *	takeImage ()
osg::HeightField *	takeHeightField ()
osg::Node *	takeNode ()
osgDB::Archive *	takeArchive ()
osg::Shader *	takeShader ()
std::string &	message ()
const std::string &	message () const
ReadStatus	status () const
bool	success () const
bool	loadedFromCache () const
bool	error () const
bool	notHandled () const
bool	notFound () const
Protected Attributes
ReadStatus	_status
std::string	_message
osg::ref_ptr< osg::Object >	_object

---

Member Enumeration Documentation

enum osgDB::ReaderWriter::ReadResult::ReadStatus

Enumerator:

FILE_NOT_HANDLED	File is not appropriate for this file reader, due to some incompatibility, but *not* a read error.
FILE_NOT_FOUND	File could not be found or could not be read.
FILE_LOADED	File successfully found, loaded, and converted into osg.
FILE_LOADED_FROM_CACHE	File found in cache and returned.
ERROR_IN_READING_FILE	File found, loaded, but an error was encountered during processing.
FILE_REQUESTED	Asyncronous file read has been requested, but returning immediatiely, keep polling plugin till file read has been completed.

---

Constructor & Destructor Documentation

osgDB::ReaderWriter::ReadResult::ReadResult

(

ReadStatus

status = FILE_NOT_HANDLED

)

[inline]

osgDB::ReaderWriter::ReadResult::ReadResult

(

const std::string &

m

)

[inline]

osgDB::ReaderWriter::ReadResult::ReadResult	(	osg::Object *	obj,
		ReadStatus	status = FILE_LOADED
	)			[inline]

osgDB::ReaderWriter::ReadResult::ReadResult

(

const ReadResult &

rr

)

[inline]

---

Member Function Documentation

bool osgDB::ReaderWriter::ReadResult::error

(

)

const [inline]

osgDB::Archive* osgDB::ReaderWriter::ReadResult::getArchive

(

)

osg::HeightField* osgDB::ReaderWriter::ReadResult::getHeightField

(

)

osg::Image* osgDB::ReaderWriter::ReadResult::getImage

(

)

osg::Node* osgDB::ReaderWriter::ReadResult::getNode

(

)

Referenced by osgDB::Registry::_buildKdTreeIfRequired().

osg::Object* osgDB::ReaderWriter::ReadResult::getObject

(

)

osg::Shader* osgDB::ReaderWriter::ReadResult::getShader

(

)

bool osgDB::ReaderWriter::ReadResult::loadedFromCache

(

)

const [inline]

const std::string& osgDB::ReaderWriter::ReadResult::message

(

)

const [inline]

std::string& osgDB::ReaderWriter::ReadResult::message

(

)

[inline]

bool osgDB::ReaderWriter::ReadResult::notFound

(

)

const [inline]

References osgDB::FILE_NOT_FOUND.

bool osgDB::ReaderWriter::ReadResult::notHandled

(

)

const [inline]

ReadResult& osgDB::ReaderWriter::ReadResult::operator=

(

const ReadResult &

rr

)

[inline]

References _message, _object, and _status.

ReadStatus osgDB::ReaderWriter::ReadResult::status

(

)

const [inline]

bool osgDB::ReaderWriter::ReadResult::success

(

)

const [inline]

osgDB::Archive* osgDB::ReaderWriter::ReadResult::takeArchive

(

)

osg::HeightField* osgDB::ReaderWriter::ReadResult::takeHeightField

(

)

osg::Image* osgDB::ReaderWriter::ReadResult::takeImage

(

)

osg::Node* osgDB::ReaderWriter::ReadResult::takeNode

(

)

osg::Object* osgDB::ReaderWriter::ReadResult::takeObject

(

)

osg::Shader* osgDB::ReaderWriter::ReadResult::takeShader

(

)

bool osgDB::ReaderWriter::ReadResult::validArchive

(

)

[inline]

bool osgDB::ReaderWriter::ReadResult::validHeightField

(

)

[inline]

bool osgDB::ReaderWriter::ReadResult::validImage

(

)

[inline]

bool osgDB::ReaderWriter::ReadResult::validNode

(

)

[inline]

Referenced by osgDB::Registry::_buildKdTreeIfRequired().

bool osgDB::ReaderWriter::ReadResult::validObject

(

)

[inline]

bool osgDB::ReaderWriter::ReadResult::validShader

(

)

[inline]

---

Member Data Documentation

std::string osgDB::ReaderWriter::ReadResult::_message [protected]

Referenced by operator=().

osg::ref_ptr<osg::Object> osgDB::ReaderWriter::ReadResult::_object [protected]

Referenced by operator=().

ReadStatus osgDB::ReaderWriter::ReadResult::_status [protected]

Referenced by operator=().

---

The documentation for this class was generated from the following file:

• osgDB/ReaderWriter