Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

vuLightfieldFile Class Reference

#include <vuLightfieldFile.h>

Inheritance diagram for vuLightfieldFile:

Inheritance graph
[legend]
Collaboration diagram for vuLightfieldFile:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vuLightfieldFile ()
 vuLightfieldFile (const char *fileName, bool isWritingMode)
 default constructor
 ~vuLightfieldFile ()
 Destructor.
const char * getFileName ()
 Returns the file name.
const vuString getErrorMessage ()
 Returns the last error message.
bool open ()
 Opens the file for reading or writing access.
void close ()
 Closes the file.
bool readHeader ()
 Reads the header.
bool writeHeader ()
 Writes the header.

Protected Member Functions

bool _setErrorMessage (const char *msg)
bool _isReadyForReading ()
bool _isReadyForWriting ()

Protected Attributes

word m_Mode
 Binary = 1 (default), ASCII=2, Compressed...
dword m_DataSize
 Data Size in bytes.
vuString m_DataName
 Name of Data.
bool m_IsWritingMode
 Status Flag, true if in writing mode, otherwise false.
vuString m_FileName
 File name.
vuString m_ErrorMessage
 Error Message.
fstream * m_FileStream
 The internal file handler.
bool m_IsHeaderDone
 Status flag, true if header is written/read, otherwise false.

Constructor & Destructor Documentation

vuLightfieldFile::vuLightfieldFile  ) 
 

Definition at line 3 of file vuLightfieldFile.cpp.

vuLightfieldFile::vuLightfieldFile const char *  fileName,
bool  isWritingMode
 

default constructor

Definition at line 10 of file vuLightfieldFile.cpp.

References m_DataName, m_DataSize, m_FileName, m_FileStream, m_IsHeaderDone, m_IsWritingMode, and m_Mode.

vuLightfieldFile::~vuLightfieldFile  ) 
 

Destructor.

Definition at line 22 of file vuLightfieldFile.cpp.

References CHECKNDELETE, and m_FileStream.


Member Function Documentation

bool vuLightfieldFile::_isReadyForReading  )  [protected]
 

Definition at line 137 of file vuLightfieldFile.cpp.

References _setErrorMessage(), and m_FileStream.

Referenced by readHeader(), and vuSphericLightfieldFile< SIZE, TYPE >::readView().

Here is the call graph for this function:

bool vuLightfieldFile::_isReadyForWriting  )  [protected]
 

Definition at line 147 of file vuLightfieldFile.cpp.

References _setErrorMessage(), and m_FileStream.

Referenced by writeHeader(), and vuSphericLightfieldFile< SIZE, TYPE >::writeView().

Here is the call graph for this function:

bool vuLightfieldFile::_setErrorMessage const char *  msg  )  [protected]
 

Definition at line 131 of file vuLightfieldFile.cpp.

References m_ErrorMessage.

Referenced by _isReadyForReading(), _isReadyForWriting(), open(), vuSphericLightfieldFile< SIZE, TYPE >::readHeader(), readHeader(), vuSphericLightfieldFile< SIZE, TYPE >::readView(), vuSphericLightfieldFile< SIZE, TYPE >::writeHeader(), writeHeader(), and vuSphericLightfieldFile< SIZE, TYPE >::writeView().

void vuLightfieldFile::close  ) 
 

Closes the file.

Definition at line 64 of file vuLightfieldFile.cpp.

References m_FileStream.

Referenced by Scanner::_lazyCalculate(), FourierSlicer< SIZE >::_lazyCalculate(), and vuSphericLightfieldBasicConverter< SI, TI, SO, TO >::convert().

const vuString vuLightfieldFile::getErrorMessage  ) 
 

Returns the last error message.

Definition at line 34 of file vuLightfieldFile.cpp.

Referenced by vuSphericLightfieldBasicConverter< SI, TI, SO, TO >::exitWithHint().

const char * vuLightfieldFile::getFileName  ) 
 

Returns the file name.

Definition at line 28 of file vuLightfieldFile.cpp.

References vuString::c_str(), and m_FileName.

Referenced by vuSphericLightfieldBasicConverter< SI, TI, SO, TO >::exitWithHint().

Here is the call graph for this function:

bool vuLightfieldFile::open  ) 
 

Opens the file for reading or writing access.

Definition at line 40 of file vuLightfieldFile.cpp.

References _setErrorMessage(), vuString::c_str(), CHECKNDELETE, vuString::isEmpty(), m_FileName, and m_FileStream.

Referenced by Scanner::_lazyCalculate(), FourierSlicer< SIZE >::_lazyCalculate(), and vuSphericLightfieldBasicConverter< SI, TI, SO, TO >::convert().

Here is the call graph for this function:

bool vuLightfieldFile::readHeader  ) 
 

Reads the header.

Reimplemented in vuSphericLightfieldFile< SIZE, TYPE >.

Definition at line 72 of file vuLightfieldFile.cpp.

References _isReadyForReading(), _setErrorMessage(), m_FileStream, m_IsHeaderDone, and m_Mode.

Referenced by vuSphericLightfieldFile< SIZE, TYPE >::readHeader().

Here is the call graph for this function:

bool vuLightfieldFile::writeHeader  ) 
 

Writes the header.

Reimplemented in vuSphericLightfieldFile< SIZE, TYPE >.

Definition at line 108 of file vuLightfieldFile.cpp.

References _isReadyForWriting(), _setErrorMessage(), vuString::isEmpty(), m_DataName, m_FileStream, m_IsHeaderDone, and m_Mode.

Referenced by vuSphericLightfieldFile< SIZE, TYPE >::writeHeader().

Here is the call graph for this function:


Member Data Documentation

vuString vuLightfieldFile::m_DataName [protected]
 

Name of Data.

Definition at line 47 of file vuLightfieldFile.h.

Referenced by vuLightfieldFile(), and writeHeader().

dword vuLightfieldFile::m_DataSize [protected]
 

Data Size in bytes.

Definition at line 45 of file vuLightfieldFile.h.

Referenced by vuLightfieldFile().

vuString vuLightfieldFile::m_ErrorMessage [protected]
 

Error Message.

Definition at line 53 of file vuLightfieldFile.h.

Referenced by _setErrorMessage().

vuString vuLightfieldFile::m_FileName [protected]
 

File name.

Definition at line 51 of file vuLightfieldFile.h.

Referenced by getFileName(), open(), and vuLightfieldFile().

fstream* vuLightfieldFile::m_FileStream [protected]
 

The internal file handler.

Definition at line 55 of file vuLightfieldFile.h.

Referenced by _isReadyForReading(), _isReadyForWriting(), close(), open(), readHeader(), vuLightfieldFile(), writeHeader(), and ~vuLightfieldFile().

bool vuLightfieldFile::m_IsHeaderDone [protected]
 

Status flag, true if header is written/read, otherwise false.

Definition at line 57 of file vuLightfieldFile.h.

Referenced by readHeader(), vuLightfieldFile(), and writeHeader().

bool vuLightfieldFile::m_IsWritingMode [protected]
 

Status Flag, true if in writing mode, otherwise false.

Definition at line 49 of file vuLightfieldFile.h.

Referenced by vuLightfieldFile().

word vuLightfieldFile::m_Mode [protected]
 

Binary = 1 (default), ASCII=2, Compressed...

Definition at line 43 of file vuLightfieldFile.h.

Referenced by readHeader(), vuLightfieldFile(), and writeHeader().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:21:18 2004 for vuVolume by  doxygen 1.3.9.1