TSE3::App::Application Class Reference

Support class providing core TSE3 application functionality. More...

#include <Application.h>

Inheritance diagram for TSE3::App::Application:

[legend]Collaboration diagram for TSE3::App::Application:

[legend]List of all members.


Public Member Functions
	Application (const std::string &appname, const std::string &appversion, TSE3::MidiSchedulerFactory *msf, const std::string &choicesFile="")
	~Application ()
const std::string &	appName () const
const std::string &	appVersion () const
TSE3::Metronome *	metronome () const
TSE3::Transport *	transport () const
TSE3::MidiScheduler *	scheduler () const
ChoicesManager *	choicesManager () const
Record *	record () const
TSE3::Ins::Destination *	destination () const
TSE3::PresetColours *	presetColours () const
bool	saveChoicesOnDestroy () const
void	setSaveChoicesOnDestroy (bool s)
void	saveChoices (const std::string &filename="")
TSE3::Song *	addSong (TSE3::Song *song=0)
size_t	numSongs () const
TSE3::Cmd::CommandHistory *	history (TSE3::Song *song)
virtual void	Notifier_Deleted (TSE3::Song *song)
Protected Attributes
std::string	_appname
std::string	_appversion
std::string	_choicesFile
TSE3::Metronome *	_metronome
TSE3::Transport *	_transport
TSE3::MidiScheduler *	_scheduler
ChoicesManager *	_cm
Record *	_record
TSE3::Ins::Destination *	_destination
TSE3::PresetColours *	_presetColours
bool	_saveChoicesOnDestroy
std::vector< TSE3::Song * >	songs
std::map< TSE3::Song , TSE3::Cmd::CommandHistory >	histories

Detailed Description

Support class providing core TSE3 application functionality.

This class provides the GUI independant core functionality of a sequencer application based upon the TSE3 library.

The functionality provided by this class includes:

Choices file saved to user's directory
Management of the lifetimes of the common TSE3 objects

This class is used as a singleton.

Author:: Pete Goodliffe

Version:: 1.00

See also:: TSE3

Constructor & Destructor Documentation

TSE3::App::Application::Application ( const std::string & appname,

const std::string & appversion,

TSE3::MidiSchedulerFactory * msf,

const std::string & choicesFile = ""

)

Create the application.

Parameters:

appname The appname supplied is the name of this application. Any use of the application name should access it from this object in future.

appversion A string containing the application version number.

msf A factory use to generate a MidiScheduler.

choicesFile The name of the file that choices are loaded from on startup, and saved to by default. You will conventionally want this to be something like "$HOME/.tse3". If you specify no choicesFile then no default choices loading/saving will be performed.

TSE3::App::Application::~Application ( )

Any Song objects 'managed' by the application will be deleted.

Member Function Documentation

const std::string& TSE3::App::Application::appName ( ) const [inline]

Returns the application's name.
If you need to quote the application's name at some point in your code, use the Application::name() method, rather than hardcoding a string constant.

const std::string& TSE3::App::Application::appVersion ( ) const [inline]

Returns the application's version.
If you need to quote the application's version at some point in your code, use the Application::name() method, rather than hardcoding a string constant.

TSE3::Metronome* TSE3::App::Application::metronome ( ) const [inline]

Returns a pointer to the Metronome object used in this application.

TSE3::Transport* TSE3::App::Application::transport ( ) const [inline]

Returns a pointer to the Transport object used in this application.

TSE3::MidiScheduler* TSE3::App::Application::scheduler ( ) const [inline]

Returns a pointer to the MidiScheduler object used in this application. This has been created from the MidiSchedulerFactory object passed to the constructor.

ChoicesManager* TSE3::App::Application::choicesManager ( ) const [inline]

Returns a pointer to the ChoicesManager.

Record* TSE3::App::Application::record ( ) const

Returns a pointer to the Application's Record object. This object is only created when it's needed.

TSE3::Ins::Destination* TSE3::App::Application::destination ( ) const [inline]

Returns the object used in this application.

TSE3::PresetColours* TSE3::App::Application::presetColours ( ) const [inline]

Returns the TSE3::PresetColours object used in this application.

bool TSE3::App::Application::saveChoicesOnDestroy ( ) const [inline]

Sets whether choices are saved on destruction or not.

See also:
setSaveChoicesOnDestroy

void TSE3::App::Application::setSaveChoicesOnDestroy ( bool s )

Returns whether choices are saved on destruction.

See also:
saveChoicesOnDestroy

void TSE3::App::Application::saveChoices ( const std::string & filename = "" )

Saves the current choices to the given filename. If no filename is supplied then the default one is used.

TSE3::Song* TSE3::App::Application::addSong ( TSE3::Song * song = 0 )

Add a new TSE3::Song to the Application object. If you don't specify a TSE3::Song, then a new TSE3::Song will be created.
You can remove the TSE3::Song by simply deleting it.

Parameters:

song TSE3::Song to add, or zero to create a new one.

Returns:
Pointer to the TSE3::Song that has been added (useful if song was zero).

size_t TSE3::App::Application::numSongs ( ) const

Returns the number of TSE3::Song objects being managed by this Application.

TSE3::Cmd::CommandHistory* TSE3::App::Application::history ( TSE3::Song * song )

Returns the object associated with this Song.

Parameters:

song TSE3::Song to get history object for.