Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XferLoad Class Reference

#include <XferLoad.h>

Inherits Xfer.

Public Member Functions

 XferLoad (void)
 
virtual ~XferLoad (void)
 
virtual void open (AsciiString identifier)
 open file for writing
 
virtual void close (void)
 close file
 
virtual Int beginBlock (void)
 read placeholder block size
 
virtual void endBlock (void)
 reading an end block is a no-op
 
virtual void skip (Int dataSize)
 skip forward dataSize bytes in file
 
virtual void xferSnapshot (Snapshot *snapshot)
 entry point for xfering a snapshot
 
virtual void xferAsciiString (AsciiString *asciiStringData)
 xfer ascii string (need our own)
 
virtual void xferUnicodeString (UnicodeString *unicodeStringData)
 xfer unicode string (need our own);
 
- 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 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)
 the xfer implementation
 

Protected Attributes

FILE * m_fileFP
 pointer to file
 
- 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 44 of file XferLoad.h.

Constructor & Destructor Documentation

◆ XferLoad()

XferLoad::XferLoad ( void )

Definition at line 39 of file XferLoad.cpp.

◆ ~XferLoad()

XferLoad::~XferLoad ( void )
virtual

Definition at line 49 of file XferLoad.cpp.

Member Function Documentation

◆ beginBlock()

Int XferLoad::beginBlock ( void )
virtual

read placeholder block size

Read a block size descriptor from the file at the current position

Implements Xfer.

Definition at line 121 of file XferLoad.cpp.

◆ close()

void XferLoad::close ( void )
virtual

close file

Close our current file

Implements Xfer.

Definition at line 97 of file XferLoad.cpp.

◆ endBlock()

void XferLoad::endBlock ( void )
virtual

reading an end block is a no-op

End block ... this does nothing when reading

Implements Xfer.

Definition at line 146 of file XferLoad.cpp.

◆ open()

void XferLoad::open ( AsciiString identifier)
virtual

open file for writing

Open file 'identifier' for reading

Implements Xfer.

Definition at line 66 of file XferLoad.cpp.

◆ skip()

void XferLoad::skip ( Int dataSize)
virtual

skip forward dataSize bytes in file

Skip forward 'dataSize' bytes in the file

Implements Xfer.

Definition at line 154 of file XferLoad.cpp.

◆ xferAsciiString()

void XferLoad::xferAsciiString ( AsciiString * asciiStringData)
virtual

xfer ascii string (need our own)

Read string from file and store in ascii string

Reimplemented from Xfer.

Definition at line 197 of file XferLoad.cpp.

◆ xferImplementation()

void XferLoad::xferImplementation ( void * data,
Int dataSize )
protectedvirtual

the xfer implementation

Perform the read operation

Implements Xfer.

Definition at line 243 of file XferLoad.cpp.

◆ xferSnapshot()

void XferLoad::xferSnapshot ( Snapshot * snapshot)
virtual

entry point for xfering a snapshot

Entry point for xfering a snapshot

Implements Xfer.

Definition at line 174 of file XferLoad.cpp.

◆ xferUnicodeString()

void XferLoad::xferUnicodeString ( UnicodeString * unicodeStringData)
virtual

xfer unicode string (need our own);

Read string from file and store in unicode string

Reimplemented from Xfer.

Definition at line 220 of file XferLoad.cpp.

Member Data Documentation

◆ m_fileFP

FILE* XferLoad::m_fileFP
protected

pointer to file

Definition at line 68 of file XferLoad.h.

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