class Panic

Playable 'panic' sequencer generator. More...

Full nameTSE3::Panic
Definition#include <Panic.h>
InheritsTSE3::Notifier [public ], TSE3::Playable [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Members


Detailed Description

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:

See also: MidiData, PhraseList

 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.

 ~Panic ()

~Panic

[virtual]

bool  status ()

status

[const]

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  setStatus (bool s)

setStatus

Sets the panic sequence.

Parameters:
sNew status value

See also: status

int  port ()

port

[const]

Returns which port the object will produce output on.

Returns: Output port number

See also: setPort

void  setPort (int port)

setPort

Sets the output port for this object.

Parameters:
portNew port number

See also: port

bool  midiReset ()

midiReset

[const]

Returns the basic MIDI reset status.

Returns: Whether MIDI reset is generated

See also: setMidiReset

void  setMidiReset (bool s)

setMidiReset

Sets the basic MIDI reset status.

Parameters:
sNew status value

See also: midiReset

bool  gmReset ()

gmReset

[const]

Returns the GM format MIDI reset status.

Returns: Whether GM reset is generated

See also: setGmReset

void  setGmReset (bool s)

setGmReset

Sets the GM format MIDI reset status.

Parameters:
sNew status value

See also: gmReset

bool  gsReset ()

gsReset

[const]

Returns the GS format MIDI reset status.

Returns: Whether GS reset is generated

See also: setGsReset

void  setGsReset (bool s)

setGsReset

Sets the GS format MIDI reset status.

Parameters:
sNew status value

See also: gsReset

bool  xgReset ()

xgReset

[const]

Returns the XG format MIDI reset status.

Returns: Whether XG reset is generated

See also: setXgReset

void  setXgReset (bool s)

setXgReset

Sets the XG format MIDI reset status.

Parameters:
sNew status value

See also: xgReset

bool  gsIDMask (size_t device)

gsIDMask

[const]

Returns the device mask for a GS device.

Parameters:
deviceA GS device ID (0-31)

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

See also: setGsIDMask

void  setGsIDMask (size_t device, bool s)

setGsIDMask

Sets a GS device mask.

Parameters:
sNew status value

See also: gsIDMask

bool  xgIDMask (size_t device)

xgIDMask

[const]

Returns the device mask for an XG device.

Parameters:
deviceAn XG device ID (0-31)

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

See also: setXgIDMask

void  setXgIDMask (size_t device, bool s)

setXgIDMask

Sets an XG device mask.

Parameters:
sNew status value

See also: xgIDMask

bool  allNotesOff ()

allNotesOff

Whether to send a MidiControl_AllNotesOff.

Returns: Whether MidiControl_AllNotesOff is generated

See also: setAllNotesOff

void  setAllNotesOff (bool s)

setAllNotesOff

Set whether to send a MidiControl_AllNotesOff.

Parameters:
sNew status value

See also: allNotesOff

bool  allNotesOffManually ()

allNotesOffManually

Whether to send a MidiCommand_NoteOff for every note manually.

Returns: Whether manual note offs are generated

See also: setAllNotesOffManually

void  setAllNotesOffManually (bool s)

setAllNotesOffManually

Set whether to send a MidiCommand_NoteOff for every note manually.

Parameters:
sNew status value

See also: allNotesOffManually

bool  allModsOff ()

allModsOff

Whether to send a MidiControl_ModulationMSB/LSB zero.

Returns: Whether MidiControl_ModulationMSB/LSB are generated

See also: setAllModsOff

void  setAllModsOff (bool s)

setAllModsOff

Set whether to send a MidiControl_ModulationMSB/LSB zero.

Parameters:
sNew status value

See also: allModsOff

bool  allPitchOff ()

allPitchOff

Whether to send a MidiCommand_PitchBend zero.

Returns: Whether MidiCommand_PitchBend zero is generated

See also: setAllPitchOff

void  setAllPitchOff (bool s)

setAllPitchOff

Set whether to send a MidiCommand_PitchBend zero.

Parameters:
sNew status value

See also: allPitchOff

bool  allCtrlOff ()

allCtrlOff

Whether to send a MidiControl_ResetAllControllers.

Returns: Whether MidiControl_ResetAllControllers is generated

See also: setAllCtrlOff

void  setAllCtrlOff (bool s)

setAllCtrlOff

Set whether to send a MidiControl_ResetAllControllers.

Parameters:
sNew status value

See also: allCtrlOff

bool  liftSustain ()

liftSustain

Whether to send a list MidiControl_SustainPedal.

Returns: Whether MidiControll_SustainPedal lift is generated

See also: setLiftSustain

void  setLiftSustain (bool s)

setLiftSustain

Set whether to send a list MidiControl_SustainPedal.

Parameters:
sNew status value

See also: liftSustain

PlayableIterator * iterator (Clock index)

iterator

[virtual]

Reimplemented from Playable for internal purposes..

Clock  lastClock ()

lastClock

[const virtual]

Reimplemented from Playable for internal purposes..

bool _status

_status

[protected]

int _port

_port

[protected]

bool _midi

_midi

[protected]

bool _gm

_gm

[protected]

bool _gs

_gs

[protected]

bool _xg

_xg

[protected]

unsigned int gsMask

gsMask

[protected]

unsigned int xgMask

xgMask

[protected]

bool _allNotesOff

_allNotesOff

[protected]

bool _allNotesOffManually

_allNotesOffManually

[protected]

bool _allModsOff

_allModsOff

[protected]

bool _allPitchOff

_allPitchOff

[protected]

bool _allCtrlOff

_allCtrlOff

[protected]

bool _liftSustain

_liftSustain

[protected]