HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
io_ReadHandle Class Reference

#include <GA_IO.h>

Public Member Functions

 io_ReadHandle ()
 
 io_ReadHandle (const GA_IO &io, const char *filename, UT_StringArray *errors)
 
 ~io_ReadHandle ()
 
bool isValid () const
 Test whether the read handle is valid. More...
 
bool isStdin () const
 Test whether the read handle reads from stdin. More...
 
UT_IStreamgetStream () const
 Get the UT_IStream associated with the handle. More...
 
UT_IStreamopen (const GA_IO &io, const char *filename, UT_StringArray *errors)
 
void close ()
 Close the stream. More...
 

Detailed Description

Class to hold information about a read stream. This class is used solely to hold the istream handles and clean up properly. Destruction of the class will close the stream

Note
The io_ReadHandle will automatically search the HOUDINI_GEOMETRY_PATH when scanning for disk files.
If the filename ends in .gz, or .sc the appropriate decompression stream wil be allocated

Definition at line 185 of file GA_IO.h.

Constructor & Destructor Documentation

io_ReadHandle::io_ReadHandle ( )
inline

Definition at line 188 of file GA_IO.h.

io_ReadHandle::io_ReadHandle ( const GA_IO &  io,
const char *  filename,
UT_StringArray errors 
)
inline

Definition at line 196 of file GA_IO.h.

io_ReadHandle::~io_ReadHandle ( )
inline

Definition at line 208 of file GA_IO.h.

Member Function Documentation

void io_ReadHandle::close ( )

Close the stream.

UT_IStream* io_ReadHandle::getStream ( ) const
inline

Get the UT_IStream associated with the handle.

Definition at line 218 of file GA_IO.h.

bool io_ReadHandle::isStdin ( ) const
inline

Test whether the read handle reads from stdin.

Definition at line 216 of file GA_IO.h.

bool io_ReadHandle::isValid ( ) const
inline

Test whether the read handle is valid.

Definition at line 214 of file GA_IO.h.

UT_IStream* io_ReadHandle::open ( const GA_IO &  io,
const char *  filename,
UT_StringArray errors 
)

Open a file for reading. If check_stdin is true and the filename starts with "stdin", the stream returned will be stdin. If the open fails, errors will be appended to the error array.


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