Xfer Class Reference

#include <Xfer.h>

Inherited by XferCRC, XferLoad, and XferSave.

Public Member Functions
	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	open (AsciiString identifier)=0
	xfer open event
virtual void	close (void)=0
	xfer close event
virtual Int	beginBlock (void)=0
	xfer begin block event
virtual void	endBlock (void)=0
	xfer end block event
virtual void	skip (Int dataSize)=0
	xfer skip data
virtual void	xferSnapshot (Snapshot *snapshot)=0
	entry point for xfering a snapshot
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)=0

Protected Attributes
UnsignedInt	m_options
	xfer options
XferMode	m_xferMode
	the current xfer mode
AsciiString	m_identifier
	the string identifier

Detailed Description

Definition at line 111 of file Xfer.h.

Constructor & Destructor Documentation

Xfer()

Xfer::Xfer

(

void

)

Definition at line 47 of file Xfer.cpp.

~Xfer()

Xfer::~Xfer ( void )

virtual

Definition at line 57 of file Xfer.cpp.

Member Function Documentation

beginBlock()

virtual Int Xfer::beginBlock ( void )

pure virtual

xfer begin block event

Implemented in XferCRC, XferLoad, and XferSave.

clearOptions()

virtual void Xfer::clearOptions ( UnsignedInt options )

inlinevirtual

Definition at line 124 of file Xfer.h.

close()

virtual void Xfer::close ( void )

pure virtual

xfer close event

Implemented in XferCRC, XferDeepCRC, XferLoad, and XferSave.

endBlock()

virtual void Xfer::endBlock ( void )

pure virtual

xfer end block event

Implemented in XferCRC, XferLoad, and XferSave.

getIdentifier()

AsciiString Xfer::getIdentifier ( void )

inline

Definition at line 120 of file Xfer.h.

getOptions()

virtual UnsignedInt Xfer::getOptions ( void )

inlinevirtual

Definition at line 125 of file Xfer.h.

getXferMode()

virtual XferMode Xfer::getXferMode ( void )

inlinevirtual

Definition at line 119 of file Xfer.h.

open()

void Xfer::open ( AsciiString identifier )

pure virtual

xfer open event

Open

Implemented in XferCRC, XferDeepCRC, XferLoad, and XferSave.

Definition at line 65 of file Xfer.cpp.

setOptions()

virtual void Xfer::setOptions ( UnsignedInt options )

inlinevirtual

Definition at line 123 of file Xfer.h.

skip()

virtual void Xfer::skip ( Int dataSize )

pure virtual

xfer skip data

Implemented in XferCRC, XferLoad, and XferSave.

xferAsciiString()

void Xfer::xferAsciiString ( AsciiString * asciiStringData )

virtual

Reimplemented in XferDeepCRC, XferLoad, and XferSave.

Definition at line 191 of file Xfer.cpp.

xferBool()

void Xfer::xferBool ( Bool * boolData )

virtual

Definition at line 112 of file Xfer.cpp.

xferByte()

void Xfer::xferByte ( Byte * byteData )

virtual

Definition at line 75 of file Xfer.cpp.

xferColor()

void Xfer::xferColor ( Color * color )

virtual

Definition at line 307 of file Xfer.cpp.

xferCoord2D()

void Xfer::xferCoord2D ( Coord2D * coord2D )

virtual

Definition at line 257 of file Xfer.cpp.

xferCoord3D()

void Xfer::xferCoord3D ( Coord3D * coord3D )

virtual

Definition at line 215 of file Xfer.cpp.

xferDrawableID()

void Xfer::xferDrawableID ( DrawableID * drawableID )

virtual

Definition at line 360 of file Xfer.cpp.

xferICoord2D()

void Xfer::xferICoord2D ( ICoord2D * iCoord2D )

virtual

Definition at line 267 of file Xfer.cpp.

xferICoord3D()

void Xfer::xferICoord3D ( ICoord3D * iCoord3D )

virtual

Definition at line 226 of file Xfer.cpp.

xferImplementation()

virtual void Xfer::xferImplementation ( void * data, Int dataSize )

protectedpure virtual

Implemented in XferCRC, XferDeepCRC, XferLoad, and XferSave.

xferInt()

void Xfer::xferInt ( Int * intData )

virtual

Definition at line 121 of file Xfer.cpp.

xferInt64()

void Xfer::xferInt64 ( Int64 * int64Data )

virtual

Definition at line 130 of file Xfer.cpp.

xferIRegion2D()

void Xfer::xferIRegion2D ( IRegion2D * iRegion2D )

virtual

Definition at line 287 of file Xfer.cpp.

xferIRegion3D()

void Xfer::xferIRegion3D ( IRegion3D * iRegion3D )

virtual

Definition at line 247 of file Xfer.cpp.

xferKindOf()

void Xfer::xferKindOf ( KindOfType * kindOfData )

virtual

kind of type, for load/save it is xfered as a string so we can reorder the kindofs if we like Version Info: 1: Initial version

Definition at line 683 of file Xfer.cpp.

xferMapName()

void Xfer::xferMapName ( AsciiString * mapNameData )

virtual

Definition at line 175 of file Xfer.cpp.

xferMarkerLabel()

void Xfer::xferMarkerLabel ( AsciiString asciiStringData )

virtual

Reimplemented in XferDeepCRC.

Definition at line 200 of file Xfer.cpp.

xferMatrix3D()

void Xfer::xferMatrix3D ( Matrix3D * mtx )

virtual

Definition at line 842 of file Xfer.cpp.

xferObjectID()

void Xfer::xferObjectID ( ObjectID * objectID )

virtual

Definition at line 351 of file Xfer.cpp.

xferReal()

void Xfer::xferReal ( Real * realData )

virtual

Definition at line 166 of file Xfer.cpp.

xferRealRange()

void Xfer::xferRealRange ( RealRange * realRange )

virtual

Definition at line 297 of file Xfer.cpp.

xferRegion2D()

void Xfer::xferRegion2D ( Region2D * region2D )

virtual

Definition at line 277 of file Xfer.cpp.

xferRegion3D()

void Xfer::xferRegion3D ( Region3D * region3D )

virtual

Definition at line 237 of file Xfer.cpp.

xferRGBAColorInt()

void Xfer::xferRGBAColorInt ( RGBAColorInt * rgbaColorInt )

virtual

Definition at line 339 of file Xfer.cpp.

xferRGBAColorReal()

void Xfer::xferRGBAColorReal ( RGBAColorReal * rgbaColorReal )

virtual

Definition at line 327 of file Xfer.cpp.

xferRGBColor()

void Xfer::xferRGBColor ( RGBColor * rgbColor )

virtual

Definition at line 316 of file Xfer.cpp.

xferScienceType()

void Xfer::xferScienceType ( ScienceType * science )

virtual

Definition at line 566 of file Xfer.cpp.

xferScienceVec()

void Xfer::xferScienceVec ( ScienceVec * scienceVec )

virtual

Definition at line 615 of file Xfer.cpp.

xferShort()

void Xfer::xferShort ( Short * shortData )

virtual

Definition at line 148 of file Xfer.cpp.

xferSnapshot()

virtual void Xfer::xferSnapshot ( Snapshot * snapshot )

pure virtual

entry point for xfering a snapshot

Implemented in XferCRC, XferLoad, and XferSave.

xferSTLIntList()

void Xfer::xferSTLIntList ( std::list< Int > * intListData )

virtual

Definition at line 500 of file Xfer.cpp.

xferSTLObjectIDList()

void Xfer::xferSTLObjectIDList ( std::list< ObjectID > * objectIDListData )

virtual

STL Object ID list (cause it's a common data structure we use a lot) Version Info; 1: Initial version

Definition at line 435 of file Xfer.cpp.

xferSTLObjectIDVector()

void Xfer::xferSTLObjectIDVector ( std::vector< ObjectID > * objectIDVectorData )

virtual

Definition at line 369 of file Xfer.cpp.

xferUnicodeString()

void Xfer::xferUnicodeString ( UnicodeString * unicodeStringData )

virtual

Reimplemented in XferDeepCRC, XferLoad, and XferSave.

Definition at line 206 of file Xfer.cpp.

xferUnsignedByte()

void Xfer::xferUnsignedByte ( UnsignedByte * unsignedByteData )

virtual

Definition at line 103 of file Xfer.cpp.

xferUnsignedInt()

void Xfer::xferUnsignedInt ( UnsignedInt * unsignedIntData )

virtual

Definition at line 139 of file Xfer.cpp.

xferUnsignedShort()

void Xfer::xferUnsignedShort ( UnsignedShort * unsignedShortData )

virtual

Definition at line 157 of file Xfer.cpp.

xferUpgradeMask()

void Xfer::xferUpgradeMask ( UpgradeMaskType * upgradeMaskData )

virtual

Definition at line 732 of file Xfer.cpp.

xferUser()

void Xfer::xferUser ( void * data, Int dataSize )

virtual

Definition at line 833 of file Xfer.cpp.

xferVersion()

void Xfer::xferVersion ( XferVersion * versionData, XferVersion currentVersion )

virtual

Definition at line 84 of file Xfer.cpp.

Member Data Documentation

m_identifier

AsciiString Xfer::m_identifier

protected

the string identifier

Definition at line 185 of file Xfer.h.

m_options

UnsignedInt Xfer::m_options

protected

xfer options

Definition at line 183 of file Xfer.h.

m_xferMode

XferMode Xfer::m_xferMode

protected

the current xfer mode

Definition at line 184 of file Xfer.h.

---

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

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