OSRTFileInputStream Class Reference

Generic file input stream. More...

#include <OSRTFileInputStream.h>

Inheritance diagram for OSRTFileInputStream:
OSRTInputStream OSRTStream

List of all members.

Public Member Functions

EXTRTMETHOD OSRTFileInputStream (const char *pFilename)
 Creates and initializes a file input stream using the name of file.
EXTRTMETHOD OSRTFileInputStream (OSRTContext *pContext, const char *pFilename)
 Creates and initializes a file input stream using the name of file.
EXTRTMETHOD OSRTFileInputStream (FILE *file)
 Initializes the file input stream using the opened FILE structure descriptor.
EXTRTMETHOD OSRTFileInputStream (OSRTContext *pContext, FILE *file)
 Initializes the file input stream using the opened FILE structure descriptor.
virtual OSBOOL isA (StreamID id) const
 This method is used to query a stream object in order to determine its actual type.

Detailed Description

Generic file input stream.

This class opens an existing file for input in binary mode and reads data from it.

Definition at line 37 of file OSRTFileInputStream.h.


Constructor & Destructor Documentation

EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream ( const char *  pFilename  ) 

Creates and initializes a file input stream using the name of file.

Parameters:
pFilename Name of file.
See also:
rtxStreamFileOpen
EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream ( OSRTContext pContext,
const char *  pFilename 
)

Creates and initializes a file input stream using the name of file.

Parameters:
pContext Pointer to a context to use.
pFilename Name of file.
See also:
rtxStreamFileOpen
EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream ( FILE *  file  ) 

Initializes the file input stream using the opened FILE structure descriptor.

Parameters:
file Pointer to FILE structure.
See also:
rtxStreamFileAttach
EXTRTMETHOD OSRTFileInputStream::OSRTFileInputStream ( OSRTContext pContext,
FILE *  file 
)

Initializes the file input stream using the opened FILE structure descriptor.

Parameters:
pContext Pointer to a context to use.
file Pointer to FILE structure.
See also:
rtxStreamFileAttach

Member Function Documentation

virtual OSBOOL OSRTFileInputStream::isA ( StreamID  id  )  const [inline, virtual]

This method is used to query a stream object in order to determine its actual type.

Parameters:
id Enumerated stream identifier
Returns:
True if the stream matches the identifier

Reimplemented from OSRTInputStream.

Definition at line 82 of file OSRTFileInputStream.h.


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