TSE3::Panic Class Reference

Playable 'panic' sequencer generator. More...

#include <Panic.h>

Inheritance diagram for TSE3::Panic:

[legend]Collaboration diagram for TSE3::Panic:

[legend]List of all members.


Public Member Functions
	Panic ()
virtual	~Panic ()
bool	status () const
void	setStatus (bool s)
int	port () const
void	setPort (int port)
bool	midiReset () const
void	setMidiReset (bool s)
bool	gmReset () const
void	setGmReset (bool s)
bool	gsReset () const
void	setGsReset (bool s)
bool	xgReset () const
void	setXgReset (bool s)
bool	gsIDMask (size_t device) const
void	setGsIDMask (size_t device, bool s)
bool	xgIDMask (size_t device) const
void	setXgIDMask (size_t device, bool s)
bool	allNotesOff ()
void	setAllNotesOff (bool s)
bool	allNotesOffManually ()
void	setAllNotesOffManually (bool s)
bool	allModsOff ()
void	setAllModsOff (bool s)
bool	allPitchOff ()
void	setAllPitchOff (bool s)
bool	allCtrlOff ()
void	setAllCtrlOff (bool s)
bool	liftSustain ()
void	setLiftSustain (bool s)
virtual PlayableIterator *	iterator (Clock index)
virtual Clock	lastClock () const
Protected Attributes
bool	_status
int	_port
bool	_midi
bool	_gm
bool	_gs
bool	_xg
unsigned int	gsMask
unsigned int	xgMask
bool	_allNotesOff
bool	_allNotesOffManually
bool	_allModsOff
bool	_allPitchOff
bool	_allCtrlOff
bool	_liftSustain

Detailed Description

Playable 'panic' sequencer generator.

The Panic class encapsulates the playable 'panic' information that can reset attached MIDI devices. This MIDI data stream is produced for a single port number, which you can specify.

Several different kinds of reset information can be sent:

A basic MIDI reset sequence
A GM format MIDI reset sequence
A GS format MIDI reset sequence (to particular device IDs)
An XG format MIDI reset sequence (to particular device IDs)
Different MIDI protocol reset messages.

Author:: Pete Goodliffe

Version:: 3.00

See also:: MidiData
PhraseList

Constructor & Destructor Documentation

TSE3::Panic::Panic ( )

Creates a Panic object with the default values. These are to send basic MIDI reset and GM MIDI reset sequences.
The default output port is MidiScheduler::AllPorts.

virtual TSE3::Panic::~Panic ( ) [virtual]

Member Function Documentation

bool TSE3::Panic::status ( ) const [inline]

Returns the panic status: whether this panic sequence is generated.
This takes precidence over all of the other status settings; if it is set to false, no MIDI events will be generated by the Panic object.

Returns:
Whether panic sequence is generated

See also:
setStatus

void TSE3::Panic::setStatus ( bool s )

Sets the panic sequence.

Parameters:

s New status value

See also:
status

int TSE3::Panic::port ( ) const [inline]

Returns which port the object will produce output on.

Returns:
Output port number

See also:
setPort

void TSE3::Panic::setPort ( int port )

Sets the output port for this object.

Parameters:

port New port number

See also:
port

bool TSE3::Panic::midiReset ( ) const [inline]

Returns the basic MIDI reset status.

Returns:
Whether MIDI reset is generated

See also:
setMidiReset

void TSE3::Panic::setMidiReset ( bool s )

Sets the basic MIDI reset status.

Parameters:

s New status value

See also:
midiReset

bool TSE3::Panic::gmReset ( ) const [inline]

Returns the GM format MIDI reset status.

Returns:
Whether GM reset is generated

See also:
setGmReset

void TSE3::Panic::setGmReset ( bool s )

Sets the GM format MIDI reset status.

Parameters:

s New status value

See also:
gmReset

bool TSE3::Panic::gsReset ( ) const [inline]

Returns the GS format MIDI reset status.

Returns:
Whether GS reset is generated

See also:
setGsReset

void TSE3::Panic::setGsReset ( bool s )

Sets the GS format MIDI reset status.

Parameters:

s New status value

See also:
gsReset

bool TSE3::Panic::xgReset ( ) const [inline]

Returns the XG format MIDI reset status.

Returns:
Whether XG reset is generated

See also:
setXgReset

void TSE3::Panic::setXgReset ( bool s )

Sets the XG format MIDI reset status.

Parameters:

s New status value

See also:
xgReset

bool TSE3::Panic::gsIDMask ( size_t device ) const

Returns the device mask for a GS device.

Parameters:

device A GS device ID (0-31)

Returns:
true if a GS reset is enabled for that device

See also:
setGsIDMask

void TSE3::Panic::setGsIDMask ( size_t device,

bool s

)

Sets a GS device mask.

Parameters:

s New status value

See also:
gsIDMask

bool TSE3::Panic::xgIDMask ( size_t device ) const

Returns the device mask for an XG device.

Parameters:

device An XG device ID (0-31)

Returns:
true if an XG reset is enabled for that device

See also:
setXgIDMask

void TSE3::Panic::setXgIDMask ( size_t device,

bool s

)

Sets an XG device mask.

Parameters:

s New status value

See also:
xgIDMask

bool TSE3::Panic::allNotesOff ( ) [inline]

Whether to send a MidiControl_AllNotesOff.

Returns:
Whether MidiControl_AllNotesOff is generated

See also:
setAllNotesOff

void TSE3::Panic::setAllNotesOff ( bool s )

Set whether to send a MidiControl_AllNotesOff.

Parameters:

s New status value

See also:
allNotesOff

bool TSE3::Panic::allNotesOffManually ( ) [inline]

Whether to send a MidiCommand_NoteOff for every note manually.

Returns:
Whether manual note offs are generated

See also:
setAllNotesOffManually

void TSE3::Panic::setAllNotesOffManually ( bool s )

Set whether to send a MidiCommand_NoteOff for every note manually.

Parameters:

s New status value

See also:
allNotesOffManually

bool TSE3::Panic::allModsOff ( ) [inline]

Whether to send a MidiControl_ModulationMSB/LSB zero.

Returns:
Whether MidiControl_ModulationMSB/LSB are generated

See also:
setAllModsOff

void TSE3::Panic::setAllModsOff ( bool s )

Set whether to send a MidiControl_ModulationMSB/LSB zero.

Parameters:

s New status value

See also:
allModsOff

bool TSE3::Panic::allPitchOff ( ) [inline]

Whether to send a MidiCommand_PitchBend zero.

Returns:
Whether MidiCommand_PitchBend zero is generated

See also:
setAllPitchOff

void TSE3::Panic::setAllPitchOff ( bool s )

Set whether to send a MidiCommand_PitchBend zero.

Parameters:

s New status value

See also:
allPitchOff

bool TSE3::Panic::allCtrlOff ( ) [inline]

Whether to send a MidiControl_ResetAllControllers.

Returns:
Whether MidiControl_ResetAllControllers is generated

See also:
setAllCtrlOff

void TSE3::Panic::setAllCtrlOff ( bool s )

Set whether to send a MidiControl_ResetAllControllers.

Parameters:

s New status value

See also:
allCtrlOff

bool TSE3::Panic::liftSustain ( ) [inline]

Whether to send a list MidiControl_SustainPedal.

Returns:
Whether MidiControll_SustainPedal lift is generated

See also:
setLiftSustain

void TSE3::Panic::setLiftSustain ( bool s )

Set whether to send a list MidiControl_SustainPedal.

Parameters:

s New status value

See also:
liftSustain