osgDB::ReaderWriter::ReadResult Class Reference

Public Types
enum	ReadStatus {   NOT_IMPLEMENTED, FILE_NOT_HANDLED, FILE_NOT_FOUND, ERROR_IN_READING_FILE,   FILE_LOADED, FILE_LOADED_FROM_CACHE, FILE_REQUESTED, INSUFFICIENT_MEMORY_TO_LOAD }

Public Member Functions
	ReadResult (ReadStatus status=FILE_NOT_HANDLED)
	ReadResult (const std::string &m)
	ReadResult (osg::Object *obj, ReadStatus status=FILE_LOADED)
template<class T >
	ReadResult (const osg::ref_ptr< T > &obj, ReadStatus status=FILE_LOADED)
	ReadResult (const ReadResult &rr)
ReadResult &	operator= (const ReadResult &rr)
bool	operator< (const ReadResult &rhs) const
osg::Object *	getObject ()
osg::Image *	getImage ()
osg::HeightField *	getHeightField ()
osg::Node *	getNode ()
osgDB::Archive *	getArchive ()
osg::Shader *	getShader ()
osg::Script *	getScript ()
bool	validObject ()
bool	validImage ()
bool	validHeightField ()
bool	validNode ()
bool	validArchive ()
bool	validShader ()
bool	validScript ()
osg::Object *	takeObject ()
osg::Image *	takeImage ()
osg::HeightField *	takeHeightField ()
osg::Node *	takeNode ()
osgDB::Archive *	takeArchive ()
osg::Shader *	takeShader ()
osg::Script *	takeScript ()
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
bool	notEnoughMemory () const

Protected Attributes
ReadStatus	_status
std::string	_message
osg::ref_ptr< osg::Object >	_object

Member Enumeration Documentation

enum osgDB::ReaderWriter::ReadResult::ReadStatus

Enumerator
NOT_IMPLEMENTED	read*() method not implemented in concrete ReaderWriter.
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.
ERROR_IN_READING_FILE	File found, loaded, but an error was encountered during processing.
FILE_LOADED	File successfully found, loaded, and converted into osg.
FILE_LOADED_FROM_CACHE	File found in cache and returned.
FILE_REQUESTED	Asynchronous file read has been requested, but returning immediately, keep polling plugin until file read has been completed.
INSUFFICIENT_MEMORY_TO_LOAD	File found but not loaded because estimated required memory surpasses available memory.

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

template<class T >

osgDB::ReaderWriter::ReadResult::ReadResult ( const osg::ref_ptr< T > &  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

(

)

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

(

)

osg::Script* osgDB::ReaderWriter::ReadResult::getScript

(

)

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

(

)

bool osgDB::ReaderWriter::ReadResult::loadedFromCache ( ) const

inline

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

inline

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

inline

bool osgDB::ReaderWriter::ReadResult::notEnoughMemory ( ) const

inline

bool osgDB::ReaderWriter::ReadResult::notFound ( ) const

inline

bool osgDB::ReaderWriter::ReadResult::notHandled ( ) const

inline

bool osgDB::ReaderWriter::ReadResult::operator< ( const ReadResult &  rhs ) const

inline

ReadResult& osgDB::ReaderWriter::ReadResult::operator= ( const ReadResult &  rr )

inline

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::Script* osgDB::ReaderWriter::ReadResult::takeScript

(

)

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

bool osgDB::ReaderWriter::ReadResult::validObject ( )

inline

bool osgDB::ReaderWriter::ReadResult::validScript ( )

inline

bool osgDB::ReaderWriter::ReadResult::validShader ( )

inline

Member Data Documentation

std::string osgDB::ReaderWriter::ReadResult::_message

protected

osg::ref_ptr<osg::Object> osgDB::ReaderWriter::ReadResult::_object

protected

ReadStatus osgDB::ReaderWriter::ReadResult::_status

protected

---

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

• osgDB/ReaderWriter