Murl::Util::IffHeader Class Reference

The Interchange File Format header format structure. More...

#include "murl_util_iff.h"

Public Types
enum	{ FOURCC_FORM }
	The FourCC constants. More...

Public Member Functions
	IffHeader ()
	The default constructor. More...
	IffHeader (UInt32 size, UInt32 fourCC)
	Constructor taking the file size and the file type identifier. More...
	IffHeader (UInt32 form, UInt32 size, UInt32 fourCC)
	Constructor taking the file identifier, the file size and the file type identifier. More...
void	SetForm (UInt32 fourCC)
	Set the file format identifier. More...
UInt32	GetForm () const
	Get the file format identifier. More...
void	SetFileSize (UInt32 size)
	Set the file size. More...
UInt32	GetFileSize () const
	Get the file size. More...
UInt32	GetRawSize () const
	Get the file size minus 8 bytes. More...
void	SetFourCC (UInt32 fourCC)
	Set the file type identifier. More...
UInt32	GetFourCC () const
	Get the file type identifier. More...

Protected Attributes
UInt32	mForm
	The file format identifier.
UInt32	mSize
	The size of the whole file minus 8 bytes.
UInt32	mFourCC
	The FourCC file type identifier.

Detailed Description

The Interchange File Format header format structure.

Member Enumeration Documentation

anonymous enum

anonymous enum

The FourCC constants.

Enumerator
FOURCC_FORM	The Interchange File Format identifier.

Constructor & Destructor Documentation

IffHeader() [1/3]

Murl::Util::IffHeader::IffHeader ( )

inline

The default constructor.

Set the file format identifier to FOURCC_FORM, the file size to 4 bytes and the file type identifier to 0.

IffHeader() [2/3]

Murl::Util::IffHeader::IffHeader ( UInt32  size, UInt32  fourCC  )

inline

Constructor taking the file size and the file type identifier.

Set the file format identifier to FOURCC_FORM. This method takes care of the system's byte ordering and the iff size format.

Parameters

size	The size of the file.
fourCC	The file type identifier.

IffHeader() [3/3]

Murl::Util::IffHeader::IffHeader ( UInt32  form, UInt32  size, UInt32  fourCC  )

inline

Constructor taking the file identifier, the file size and the file type identifier.

This method takes care of the system's byte ordering and the iff size format.

Parameters

form	The file format identifier.
size	The size of the file.
fourCC	The file type identifier.

Member Function Documentation

SetForm()

void Murl::Util::IffHeader::SetForm ( UInt32  fourCC )

inline

Set the file format identifier.

This method takes care of the system's byte ordering.

Parameters

fourCC

The FourCC file format identifier.

References Murl::Util::IffFourCC(), and mForm.

GetForm()

UInt32 Murl::Util::IffHeader::GetForm ( ) const

inline

Get the file format identifier.

This method takes care of the system's byte ordering.

Returns

The FourCC file format identifier.

References Murl::Util::IffFourCC(), and mForm.

SetFileSize()

void Murl::Util::IffHeader::SetFileSize ( UInt32  size )

inline

Set the file size.

This method takes care of the iff size format.

Parameters

size	The byte size of the file.

References mForm, and mSize.

GetFileSize()

UInt32 Murl::Util::IffHeader::GetFileSize ( ) const

inline

Get the file size.

This method takes care of the iff size format.

Returns

The byte size of the file.

References mForm, and mSize.

GetRawSize()

UInt32 Murl::Util::IffHeader::GetRawSize ( ) const

inline

Get the file size minus 8 bytes.

Returns

The byte size of the file minus 8 bytes.

References mSize.

SetFourCC()

void Murl::Util::IffHeader::SetFourCC ( UInt32  fourCC )

inline

Set the file type identifier.

This method takes care of the system's byte ordering.

Parameters

fourCC

The FourCC file type identifier.

References Murl::Util::IffFourCC(), and mFourCC.

GetFourCC()

UInt32 Murl::Util::IffHeader::GetFourCC ( ) const

inline

Get the file type identifier.

This method takes care of the system's byte ordering.

Returns

The FourCC file type identifier.

References Murl::Util::IffFourCC(), and mFourCC.

---

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

• murl_util_iff.h