stmg::XmlGameFiles Class Reference

Interface locating xml files related to games. More...

Inheritance diagram for stmg::XmlGameFiles:

Public Member Functions
virtual	~XmlGameFiles ()=default
virtual const std::vector< File > &	getGameFiles () noexcept=0
	The game files. More...
virtual const File &	getGameThumbnailFile (const File &oGameFile) noexcept=0
	The thumbnail file associated with a game file. More...
virtual File	getHighscoreFile (const std::string &sGameName) noexcept=0
	The highscores file for a specific game. More...
virtual File	getPreferencesFile ()=0
	The preferences file. More...

Protected Member Functions
	XmlGameFiles ()=default

Detailed Description

Interface locating xml files related to games.

Constructor & Destructor Documentation

~XmlGameFiles()

virtual stmg::XmlGameFiles::~XmlGameFiles ( )

virtualdefault

XmlGameFiles()

stmg::XmlGameFiles::XmlGameFiles ( )

protecteddefault

Member Function Documentation

getGameFiles()

virtual const std::vector< File >& stmg::XmlGameFiles::getGameFiles ( )

pure virtualnoexcept

The game files.

Returns

The files. Are all defined. Can be empty.

Implemented in stmg::GameDiskFiles.

getGameThumbnailFile()

virtual const File& stmg::XmlGameFiles::getGameThumbnailFile ( const File &  oGameFile )

pure virtualnoexcept

The thumbnail file associated with a game file.

Parameters

oGameFile

The game file. Must be one of the files returned by getGameFiles().

Returns

The thumbnail file. Can be undefined (means no thumbnail available).

Implemented in stmg::GameDiskFiles.

getHighscoreFile()

virtual File stmg::XmlGameFiles::getHighscoreFile ( const std::string &  sGameName )

pure virtualnoexcept

The highscores file for a specific game.

The game name is usually defined somewhere in the contents of the xml files returned by getGameFiles().

Parameters

sGameName

The internal game name. Cannot be empty.

Returns

The highscores file. Undefined if unknown game name or no highscores available.

Implemented in stmg::GameDiskFiles.

getPreferencesFile()

virtual File stmg::XmlGameFiles::getPreferencesFile ( )

pure virtual

The preferences file.

Returns

The preferences file. Can be undefined.

Implemented in stmg::GameDiskFiles.