XferCRC Class Reference

#include <XferCRC.h>

Inherits Xfer.

Inherited by XferDeepCRC.

Public Member Functions
	XferCRC (void)
virtual	~XferCRC (void)
virtual void	open (AsciiString identifier)
	start a CRC session with this xfer instance
virtual void	close (void)
	stop CRC session
virtual Int	beginBlock (void)
	start block event
virtual void	endBlock (void)
	end block event
virtual void	skip (Int dataSize)
	skip xfer event
virtual void	xferSnapshot (Snapshot *snapshot)
	entry point for xfering a snapshot
virtual UnsignedInt	getCRC (void)
	get computed CRC in network byte order
Public Member Functions inherited from Xfer
	Xfer (void)
virtual	~Xfer (void)
virtual XferMode	getXferMode (void)
AsciiString	getIdentifier (void)
virtual void	setOptions (UnsignedInt options)
virtual void	clearOptions (UnsignedInt options)
virtual UnsignedInt	getOptions (void)
virtual void	xferVersion (XferVersion *versionData, XferVersion currentVersion)
virtual void	xferByte (Byte *byteData)
virtual void	xferUnsignedByte (UnsignedByte *unsignedByteData)
virtual void	xferBool (Bool *boolData)
virtual void	xferInt (Int *intData)
virtual void	xferInt64 (Int64 *int64Data)
virtual void	xferUnsignedInt (UnsignedInt *unsignedIntData)
virtual void	xferShort (Short *shortData)
virtual void	xferUnsignedShort (UnsignedShort *unsignedShortData)
virtual void	xferReal (Real *realData)
virtual void	xferMarkerLabel (AsciiString asciiStringData)
virtual void	xferAsciiString (AsciiString *asciiStringData)
virtual void	xferUnicodeString (UnicodeString *unicodeStringData)
virtual void	xferCoord3D (Coord3D *coord3D)
virtual void	xferICoord3D (ICoord3D *iCoord3D)
virtual void	xferRegion3D (Region3D *region3D)
virtual void	xferIRegion3D (IRegion3D *iRegion3D)
virtual void	xferCoord2D (Coord2D *coord2D)
virtual void	xferICoord2D (ICoord2D *iCoord2D)
virtual void	xferRegion2D (Region2D *region2D)
virtual void	xferIRegion2D (IRegion2D *iRegion2D)
virtual void	xferRealRange (RealRange *realRange)
virtual void	xferColor (Color *color)
virtual void	xferRGBColor (RGBColor *rgbColor)
virtual void	xferRGBAColorReal (RGBAColorReal *rgbaColorReal)
virtual void	xferRGBAColorInt (RGBAColorInt *rgbaColorInt)
virtual void	xferObjectID (ObjectID *objectID)
virtual void	xferDrawableID (DrawableID *drawableID)
virtual void	xferSTLObjectIDVector (std::vector< ObjectID > *objectIDVectorData)
virtual void	xferSTLObjectIDList (std::list< ObjectID > *objectIDListData)
virtual void	xferSTLIntList (std::list< Int > *intListData)
virtual void	xferScienceType (ScienceType *science)
virtual void	xferScienceVec (ScienceVec *scienceVec)
virtual void	xferKindOf (KindOfType *kindOfData)
virtual void	xferUpgradeMask (UpgradeMaskType *upgradeMaskData)
virtual void	xferUser (void *data, Int dataSize)
virtual void	xferMatrix3D (Matrix3D *mtx)
virtual void	xferMapName (AsciiString *mapNameData)

Protected Member Functions
virtual void	xferImplementation (void *data, Int dataSize)
void	addCRC (UnsignedInt val)
	CRC a 4-byte block.

Protected Attributes
UnsignedInt	m_crc
Protected Attributes inherited from Xfer
UnsignedInt	m_options
	xfer options
XferMode	m_xferMode
	the current xfer mode
AsciiString	m_identifier
	the string identifier

Detailed Description

Definition at line 43 of file XferCRC.h.

Constructor & Destructor Documentation

XferCRC()

XferCRC::XferCRC

(

void

)

Definition at line 41 of file XferCRC.cpp.

~XferCRC()

XferCRC::~XferCRC ( void )

virtual

Definition at line 53 of file XferCRC.cpp.

Member Function Documentation

addCRC()

void XferCRC::addCRC ( UnsignedInt val )

protected

CRC a 4-byte block.

Definition at line 98 of file XferCRC.cpp.

beginBlock()

Int XferCRC::beginBlock ( void )

virtual

start block event

Implements Xfer.

Definition at line 82 of file XferCRC.cpp.

close()

void XferCRC::close ( void )

virtual

stop CRC session

Close our current file

Implements Xfer.

Reimplemented in XferDeepCRC.

Definition at line 75 of file XferCRC.cpp.

endBlock()

void XferCRC::endBlock ( void )

virtual

end block event

Implements Xfer.

Definition at line 91 of file XferCRC.cpp.

getCRC()

UnsignedInt XferCRC::getCRC ( void )

virtual

get computed CRC in network byte order

Definition at line 179 of file XferCRC.cpp.

open()

void XferCRC::open ( AsciiString identifier )

virtual

start a CRC session with this xfer instance

Open file 'identifier' for writing

Implements Xfer.

Reimplemented in XferDeepCRC.

Definition at line 61 of file XferCRC.cpp.

skip()

void XferCRC::skip ( Int dataSize )

virtual

skip xfer event

Implements Xfer.

Definition at line 172 of file XferCRC.cpp.

xferImplementation()

void XferCRC::xferImplementation ( void * data, Int dataSize )

protectedvirtual

Perform a single CRC operation on the data passed in

Implements Xfer.

Reimplemented in XferDeepCRC.

Definition at line 140 of file XferCRC.cpp.

xferSnapshot()

void XferCRC::xferSnapshot ( Snapshot * snapshot )

virtual

entry point for xfering a snapshot

Entry point for xfering a snapshot

Implements Xfer.

Definition at line 122 of file XferCRC.cpp.

Member Data Documentation

m_crc

UnsignedInt XferCRC::m_crc

protected

Definition at line 69 of file XferCRC.h.

---

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

• Code/GameEngine/Include/Common/XferCRC.h
• Code/GameEngine/Source/Common/System/XferCRC.cpp