TSE3::TSE2MDL Class Reference

TSE version 2 file operations. More...

#include <TSE2MDL.h>

Collaboration diagram for TSE3::TSE2MDL:

[legend]List of all members.

Public Member Functions
	TSE2MDL (const std::string &appname="", bool verbose=false, std::ostream &out=std::cout)
Song *	load (const std::string &filename, Progress *progress=0)

---

Detailed Description

TSE version 2 file operations.

This class provides file import for TSE2MDL files.

It uses the TSE2MDL file type, as created by programs based on the earlier TSE2 library. This format differs somewhat from the TSE3MDL format, notably in that it is a binary format. It is not forwards and backwards compatible, and it does not support all of TSE3's Song structure. Since these files are produced by programs based on the older TSE2 library this class is provided merely for compatibility.

When saving/loading TSE3 Song objects, you should prefer the TSE3MDL file format which is accessed via the TSE3MDL class.

You may see TSE2MDL files referred to simply as 'TSEMDL' files.

Author:

Pete Goodliffe

Version:

3.00

---

Constructor & Destructor Documentation

TSE3::TSE2MDL::TSE2MDL (  const std::string &  appname = "", bool  verbose = false, std::ostream &  out = std::cout )

Creates a TSE2MDL object for the given TSEMDL file. Parameters: appname  Name of the application using TSE3. This is saved into the TSE3MDL file header (Not currently used, would be by a future export method.) verbose  Whether to produce diagnostic output. out  ostream to produce diagnostic output on.

---

Member Function Documentation

Song* TSE3::TSE2MDL::load (  const std::string &  filename, Progress *  progress = 0 )

Performs the TSE2MDL file import, and returns a pointer to a Song object holding the imported data. This Song object has been newed by the TSE2MDL object; it is your responsibility to delete it. Parameters: filename  Filename of TSE2MDL file to import. Returns: The imported Song - you must delete it

---

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

• /home/pete/Work/TSE3.svn/tse3/src/tse3/TSE2MDL.h

---