HoverRace::Parcel::Bundle Class Reference

A source of parcels. More...

#include <Bundle.h>

Inheritance diagram for HoverRace::Parcel::Bundle:

Classes
class	Iterator

Public Types
using	const_iterator = Iterator
using	iterator = Iterator
using	value_type = Util::OS::dirEnt_t

Public Member Functions
	Bundle (const Util::OS::path_t &dir, std::shared_ptr< Bundle > subBundle=std::shared_ptr< Bundle >())
	Constructor. More...
virtual	~Bundle ()
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
const_iterator	cend () const
iterator	end ()
const_iterator	end () const
virtual std::shared_ptr< RecordFile >	OpenParcel (const std::string &name, bool writing=false) const
	Open an existing parcel. More...

Private Attributes
Util::OS::path_t	dir
std::shared_ptr< Bundle >	subBundle

Static Private Attributes
static const iterator	END

Detailed Description

A source of parcels.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Parcel::Bundle::const_iterator = Iterator

using HoverRace::Parcel::Bundle::iterator = Iterator

using HoverRace::Parcel::Bundle::value_type = Util::OS::dirEnt_t

Constructor & Destructor Documentation

HoverRace::Parcel::Bundle::Bundle	(	const Util::OS::path_t &	dir,
		std::shared_ptr< Bundle >	subBundle = std::shared_ptr<Bundle>()
	)

Constructor.

Parameters

dir	The directory (does not need to exist).
subBundle	Optional fall-back bundle.

virtual HoverRace::Parcel::Bundle::~Bundle ( )

inlinevirtual

Member Function Documentation

iterator HoverRace::Parcel::Bundle::begin ( )

inline

const_iterator HoverRace::Parcel::Bundle::begin ( ) const

inline

const_iterator HoverRace::Parcel::Bundle::cbegin ( ) const

inline

const_iterator HoverRace::Parcel::Bundle::cend ( ) const

inline

iterator HoverRace::Parcel::Bundle::end ( )

inline

const_iterator HoverRace::Parcel::Bundle::end ( ) const

inline

std::shared_ptr< RecordFile > HoverRace::Parcel::Bundle::OpenParcel ( const std::string &  name, bool  writing = false  ) const

virtual

Open an existing parcel.

All parcels, including sub-bundles, will be searched.

Parameters

name	The name of the parcel.
writing	true if the parcel will be written to, false if read-only.

Returns

The parcel (may be nullptr if parcel does not exist).

Reimplemented in HoverRace::Parcel::TrackBundle.

Member Data Documentation

Util::OS::path_t HoverRace::Parcel::Bundle::dir

private

const Bundle::iterator HoverRace::Parcel::Bundle::END

staticprivate

std::shared_ptr<Bundle> HoverRace::Parcel::Bundle::subBundle

private

---

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

• Bundle.h
• Bundle.cpp