TSE3::Ins::CakewalkInstrumentFile Class Reference

Cakewalk .ins file parser. More...

#include <Instrument.h>

List of all members.

Public Member Functions
	CakewalkInstrumentFile (const std::string &filename)
const std::list< std::string > &	instruments (TSE3::Progress *progress=0)
Instrument *	instrument (const std::string &title, TSE3::Progress *progress=0)

---

Detailed Description

Cakewalk .ins file parser.

The class represents a Cakewalk .ins file.

It provides a mechanism for listing all instruments provided by a particular .ins file, and for creating an Instrument object from it.

The .ins file format is not documented. However, the documentation that ships with the TSE3 library contains a description of this format.

Author:

Pete Goodliffe

Version:

3.00

See also:

Instrument

---

Constructor & Destructor Documentation

TSE3::Ins::CakewalkInstrumentFile::CakewalkInstrumentFile (  const std::string &  filename  )

Create an object for the given file. Parameters: filename  The name of the Cakewalk .ins file

---

Member Function Documentation

const std::list<std::string>& TSE3::Ins::CakewalkInstrumentFile::instruments (  TSE3::Progress *  progress = 0  )

Returns a set of the instrument titles in the .ins file. The first time you call this method, the file will be searched. Whilst this is being done you can be informted of progress via the TSE3::Progress interface. Parameters: progress  callback, or zero for no callback Returns: List of instrument titles in the .ins file

Instrument* TSE3::Ins::CakewalkInstrumentFile::instrument (  const std::string &  title, TSE3::Progress *  progress = 0 )

Factory method that creates an Instrument object for the given instrument title from this CakewalkInstrumentFile. You can supply a interface to be informed of progress. Parameters: title  The title of the instrument to create progress  callback, or zero for no callback Returns: New instrument object - you must delete this object

---

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

• /home/pete/Work/TSE3.svn/tse3/src/tse3/ins/Instrument.h

---