MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
LTIOFileStream Class Reference

File stream. More...

#include <lt_ioFileStream.h>

Inheritance diagram for LTIOFileStream:
LTIOStreamInf

Public Member Functions

Construction, destruction, initialization
 LTIOFileStream (void)
 Default Constructor. More...
 
virtual ~LTIOFileStream (void)
 Destructor. More...
 
virtual LT_STATUS initialize (const LTFileSpec &fs, const char *mode)
 Initializes the stream from a file spec. More...
 
LT_STATUS initialize (const char *path, const char *mode)
 Default Constructor. More...
 
virtual bool isEOF ()
 Default Constructor. More...
 
virtual bool isOpen ()
 Default Constructor. More...
 
virtual LT_STATUS open ()
 Default Constructor. More...
 
virtual LT_STATUS close ()
 Default Constructor. More...
 
virtual lt_uint32 read (lt_uint8 *pDest, lt_uint32 numBytes)
 Default Constructor. More...
 
virtual lt_uint32 write (const lt_uint8 *pSrc, lt_uint32 numBytes)
 Default Constructor. More...
 
virtual LT_STATUS seek (lt_int64 offset, LTIOSeekDir origin)
 Default Constructor. More...
 
virtual lt_int64 tell ()
 Default Constructor. More...
 
virtual LTIOStreamInf * duplicate ()
 Default Constructor. More...
 
virtual LT_STATUS getLastError () const
 Default Constructor. More...
 
virtual const char * getID () const
 Default Constructor. More...
 
- Public Member Functions inherited from LTIOStreamInf
virtual ~LTIOStreamInf ()=0
 
virtual char * readString (int delimiter='\0')
 read a delimiter-terminated string More...
 

Status accessors

FILE * m_file
 Returns underlying stdio error code. More...
 
bool m_onceOpened
 Returns underlying stdio error code. More...
 
enum LTIOFileStream:: { ... }  m_state
 Returns underlying stdio error code. More...
 
LTFileSpec m_path
 Returns underlying stdio error code. More...
 
char * m_mode
 Returns underlying stdio error code. More...
 
char * m_uri
 Returns underlying stdio error code. More...
 
int stdio_ferror ()
 Returns underlying stdio error code. More...
 
void stdio_clearerr ()
 Clears underlying stdio error code. More...
 
int stdio_setvbuf (lt_uint8 *buf, lt_uint32 mode, lt_uint32 size)
 Set buffering - may be called only after open() but before the first read/write operation. More...
 

Detailed Description

This class implements a file-based stream.

Examples
DerivedImageReader.cpp, and UsingStreams.cpp.

Definition at line 34 of file lt_ioFileStream.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
unknown_state 
reading_state 
writing_state 

Definition at line 119 of file lt_ioFileStream.h.

Constructor & Destructor Documentation

◆ LTIOFileStream()

LTIOFileStream::LTIOFileStream ( void  )

◆ ~LTIOFileStream()

virtual LTIOFileStream::~LTIOFileStream ( void  )
virtual

Member Function Documentation

◆ close()

virtual LT_STATUS LTIOFileStream::close ( )
virtual

Implements LTIOStreamInf.

Examples
UsingStreams.cpp.

◆ duplicate()

virtual LTIOStreamInf* LTIOFileStream::duplicate ( )
virtual

Implements LTIOStreamInf.

◆ getID()

virtual const char* LTIOFileStream::getID ( ) const
virtual

Implements LTIOStreamInf.

◆ getLastError()

virtual LT_STATUS LTIOFileStream::getLastError ( ) const
virtual

Implements LTIOStreamInf.

◆ initialize() [1/2]

LT_STATUS LTIOFileStream::initialize ( const char *  path,
const char *  mode 
)

◆ initialize() [2/2]

virtual LT_STATUS LTIOFileStream::initialize ( const LTFileSpec &  fs,
const char *  mode 
)
virtual
Parameters
fsfile spec
modemode (see stdio.h)
Examples
DerivedImageReader.cpp, and UsingStreams.cpp.

◆ isEOF()

virtual bool LTIOFileStream::isEOF ( )
virtual

Implements LTIOStreamInf.

◆ isOpen()

virtual bool LTIOFileStream::isOpen ( )
virtual

Implements LTIOStreamInf.

◆ open()

virtual LT_STATUS LTIOFileStream::open ( )
virtual

Implements LTIOStreamInf.

Examples
UsingStreams.cpp.

◆ read()

virtual lt_uint32 LTIOFileStream::read ( lt_uint8 *  pDest,
lt_uint32  numBytes 
)
virtual

Implements LTIOStreamInf.

Examples
UsingStreams.cpp.

◆ seek()

virtual LT_STATUS LTIOFileStream::seek ( lt_int64  offset,
LTIOSeekDir  origin 
)
virtual

Implements LTIOStreamInf.

Examples
UsingStreams.cpp.

◆ stdio_clearerr()

void LTIOFileStream::stdio_clearerr ( )

◆ stdio_ferror()

int LTIOFileStream::stdio_ferror ( )

◆ stdio_setvbuf()

int LTIOFileStream::stdio_setvbuf ( lt_uint8 *  buf,
lt_uint32  mode,
lt_uint32  size 
)
Parameters
bufbuffer to use; if nullptr then one is allocated
modeone of the following: _IONBF (unbuffered) _IOLBF (line buffered) _IOFBF (fully buffered)
sizesize of buffer

◆ tell()

virtual lt_int64 LTIOFileStream::tell ( )
virtual

Implements LTIOStreamInf.

Examples
UsingStreams.cpp.

◆ write()

virtual lt_uint32 LTIOFileStream::write ( const lt_uint8 *  pSrc,
lt_uint32  numBytes 
)
virtual

Implements LTIOStreamInf.

Member Data Documentation

◆ m_file

FILE* LTIOFileStream::m_file
protected

Definition at line 115 of file lt_ioFileStream.h.

◆ m_mode

char* LTIOFileStream::m_mode
protected

Definition at line 127 of file lt_ioFileStream.h.

◆ m_onceOpened

bool LTIOFileStream::m_onceOpened
protected

Definition at line 116 of file lt_ioFileStream.h.

◆ m_path

LTFileSpec LTIOFileStream::m_path
protected

Definition at line 126 of file lt_ioFileStream.h.

◆ 

enum { ... } LTIOFileStream::m_state

◆ m_uri

char* LTIOFileStream::m_uri
protected

Definition at line 128 of file lt_ioFileStream.h.


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

Extensis