NotesWriterSSC Namespace Reference

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

Functions
bool	Write (std::string &sPath, const Song &out, const std::vector< Steps * > &vpStepsToSave, bool bSavingCache)
	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.
std::string	MSDToString (const std::vector< std::vector< float > > &x)
std::string	MSDsAtRateToString (const std::vector< float > &x)

Detailed Description

Writes a Song to an .SSC file.

Function Documentation

GetEditFileContents()

void NotesWriterSSC::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 NotesWriterSSC::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 NotesWriterSSC::Write	(	std::string &	sPath,
		const Song &	out,
		const std::vector< Steps * > &	vpStepsToSave,
		bool	bSavingCache
	)

Write the song out to a file.

Parameters

sPath	the path to write the file.
out	the Song to be written out.
vpStepsToSave	the Steps to save.
bSavingCache	a flag to see if we're saving certain cache data.

Returns

its success or failure.

WriteEditFileToMachine()

bool NotesWriterSSC::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.