NotesWriterSM Namespace Reference

Writes a Song to an .SM file. More...

Functions
bool	Write (const std::string &sPath, Song &out, const std::vector< Steps * > &vpStepsToSave)
	Write the song out to a file.
void	GetEditFileContents (const Song *pSong, const Steps *pSteps, std::string &sOut)
	Get some contents about the edit file first.
std::string	GetEditFileName (const Song *pSong, const Steps *pSteps)
	Get the name of the edit file to use.
bool	WriteEditFileToMachine (const Song *pSong, Steps *pSteps, std::string &sErrorOut)
	Write the edit file to the machine for future use.

Detailed Description

Writes a Song to an .SM file.

Function Documentation

GetEditFileContents()

void NotesWriterSM::GetEditFileContents	(	const Song *	pSong,
		const Steps *	pSteps,
		std::string &	sOut
	)

Get some contents about the edit file first.

Parameters

pSong	the Song in question.
pSteps	the Steps in question.
sOut	the start of the file contents.

GetEditFileName()

std::string NotesWriterSM::GetEditFileName	(	const Song *	pSong,
		const Steps *	pSteps
	)

Get the name of the edit file to use.

Parameters

pSong	the Song in question.
pSteps	the Steps in question.

Returns

the name of the edit file.

Write()

bool NotesWriterSM::Write	(	const std::string &	sPath,
		Song &	out,
		const std::vector< Steps * > &	vpStepsToSave
	)

Write the song out to a file.

Parameters

sPath	the path to write the file.
out	the Song to be written out.

Returns

its success or failure.

WriteEditFileToMachine()

bool NotesWriterSM::WriteEditFileToMachine	(	const Song *	pSong,
		Steps *	pSteps,
		std::string &	sErrorOut
	)

Write the edit file to the machine for future use.

Parameters

pSong	the Song in question.
pSteps	the Steps in question.
sErrorOut	any error messages that may have occurred.

Returns

its success or failure.