HoverRace: HoverRace::Parcel::RecordFile Class Reference

HoverRace 2.0

Base class for parcel implementations. More...

#include <RecordFile.h>

Inheritance diagram for HoverRace::Parcel::RecordFile:

Public Member Functions
	RecordFile ()

virtual	~RecordFile ()

virtual bool	ApplyChecksum (const Util::OS::path_t &filename)=0

virtual bool	BeginANewRecord ()=0

virtual bool	CreateForWrite (const Util::OS::path_t &filename, MR_UInt32 numRecords, const char *title=nullptr)=0

virtual DWORD	GetAlignMode ()=0

virtual MR_UInt32	GetNbRecords () const =0

virtual bool	OpenForRead (const Util::OS::path_t &filename, bool validateChecksum=false)=0

virtual bool	OpenForWrite (const Util::OS::path_t &filename)=0

virtual void	SelectRecord (MR_UInt32 i)=0

virtual ObjStreamPtr	StreamIn ()=0
	Open an object stream for reading at the current record. More...

virtual ObjStreamPtr	StreamOut ()=0
	Open an object stream for writing at the current record. More...

Public Member Functions inherited from HoverRace::Util::Inspectable
	Inspectable ()

virtual	~Inspectable ()

virtual void	Inspect (InspectMapNode &node) const =0

Private Types
using	SUPER = Util::Inspectable

Detailed Description

Base class for parcel implementations.

Author: Michael Imamura

Member Typedef Documentation

using HoverRace::Parcel::RecordFile::SUPER = Util::Inspectable

private

Constructor & Destructor Documentation

HoverRace::Parcel::RecordFile::RecordFile ( )

inline

virtual HoverRace::Parcel::RecordFile::~RecordFile ( )

inlinevirtual

Member Function Documentation

virtual bool HoverRace::Parcel::RecordFile::ApplyChecksum ( const Util::OS::path_t & filename )

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual bool HoverRace::Parcel::RecordFile::BeginANewRecord ( )

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual bool HoverRace::Parcel::RecordFile::CreateForWrite	(	const Util::OS::path_t &	filename,
		MR_UInt32	numRecords,
		const char *	title = `nullptr`
	)

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual DWORD HoverRace::Parcel::RecordFile::GetAlignMode ( )

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual MR_UInt32 HoverRace::Parcel::RecordFile::GetNbRecords ( ) const

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual bool HoverRace::Parcel::RecordFile::OpenForRead	(	const Util::OS::path_t &	filename,
		bool	validateChecksum = `false`
	)

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual bool HoverRace::Parcel::RecordFile::OpenForWrite ( const Util::OS::path_t & filename )

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual void HoverRace::Parcel::RecordFile::SelectRecord ( MR_UInt32 i )

pure virtual

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual ObjStreamPtr HoverRace::Parcel::RecordFile::StreamIn ( )

pure virtual

Open an object stream for reading at the current record.

It is the caller's responsibility to ensure that only one stream (input or output) exists at a time.

Returns: A shared pointer to the new input stream (never NULL).

Implemented in HoverRace::Parcel::ClassicRecordFile.

virtual ObjStreamPtr HoverRace::Parcel::RecordFile::StreamOut ( )

pure virtual

Open an object stream for writing at the current record.

It is the caller's responsibility to ensure that only one stream (input or output) exists at a time.

Returns: A shared pointer to the new output stream (never NULL).

Implemented in HoverRace::Parcel::ClassicRecordFile.

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

RecordFile.h