HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
io_WriteHandle Class Reference

#include <GA_IO.h>

Public Member Functions

 io_WriteHandle ()
 
 io_WriteHandle (const GA_IO &io, const char *filename, UT_StringArray *errors)
 
 ~io_WriteHandle ()
 
bool isValid () const
 Check if the stream is valid. More...
 
std::ostream * getStream () const
 Get the output stream. More...
 
std::ostream * open (const GA_IO &io, const char *filename, UT_StringArray *errors)
 
void close ()
 Close the stream. More...
 

Detailed Description

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

Definition at line 241 of file GA_IO.h.

Constructor & Destructor Documentation

io_WriteHandle::io_WriteHandle ( )
inline

Definition at line 244 of file GA_IO.h.

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

Definition at line 249 of file GA_IO.h.

io_WriteHandle::~io_WriteHandle ( )
inline

Definition at line 256 of file GA_IO.h.

Member Function Documentation

void io_WriteHandle::close ( )

Close the stream.

std::ostream* io_WriteHandle::getStream ( ) const
inline

Get the output stream.

Definition at line 264 of file GA_IO.h.

bool io_WriteHandle::isValid ( ) const
inline

Check if the stream is valid.

Definition at line 262 of file GA_IO.h.

std::ostream* io_WriteHandle::open ( const GA_IO &  io,
const char *  filename,
UT_StringArray *  errors 
)

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

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