CSIILPPMFileDriver Class Reference

PPM file loader class. More...

#include <SIILPPMFileDriver.h>

Inheritance diagram for CSIILPPMFileDriver:

CSIBCPixMapDriver List of all members.

Public Member Functions
  CSIILPPMFileDriver ()
virtual  ~CSIILPPMFileDriver ()
virtual SI_Bool  Supported (CSIBCString &in_Filename)
virtual SI_Error  Load (CSIBCString &in_filename, CSIBCPixMap &in_PixMap)

Static Public Member Functions
static CSIILPPMFileDriver *  Driver ()

Detailed Description

PPM file loader class.

Constructor & Destructor Documentation

CSIILPPMFileDriver (  ) 

Constructor

virtual ~CSIILPPMFileDriver (  )  [virtual]

Destructor

Member Function Documentation

virtual SI_Bool Supported ( CSIBCString &  in_Filename  )  [virtual]

Returns whether the extension in the specified filename is supported by this driver

Parameters:
in_Filename  file name to check
Returns:
TRUE if this file is supported

FALSE otherwise

Implements CSIBCPixMapDriver.

virtual SI_Error Load ( CSIBCString &  in_filename,
CSIBCPixMap &  in_PixMap  
) [virtual]

Loads a Portable Pixmap file into a CSIBCPixMap object

Parameters:
in_filename  PPM file name
in_PixMap  CSIBCPixMap object to load the file into
Returns:
SI_Error::SI_SUCCESS loading has been succesful

SI_Error::SI_ERR_ERROR_MSG loading has failed

SI_Error::SI_FILE_NOT_FOUND the file has not been found

Implements CSIBCPixMapDriver.

static CSIILPPMFileDriver* Driver (  )  [static]

Returns the global PPM loader instance

Returns:
instance of loader

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