Class: TMIDIChannelPacket

Declaration: MIDI.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMIDIPacket

Inherited By:

TMIDINoteOffPacket TMIDINoteOnPacket

Purpose:

An abstract base class for convenient access to MIDI channel messages.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to provide concrete instances of MIDI channel messages.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMIDIChannelPacket::TMIDIChannelPacket

TMIDIChannelPacket (const TMIDIPacket &)
TMIDIChannelPacket (const TMIDIChannelPacket &)
TMIDIChannelPacket (const TTime & timeStamp, Channel, DataIndex length)

Interface Category:

API.

Purpose:

Constructor.
Copy constructor.
Constructor.

Calling Context:

Called by a derived class to convert a TMIDIPacket object.
Called by a derived class to copy an object.
Called by a derived class to construct a channel packet.

Parameters:

const TMIDIPacket & -The packet to convert.
const TMIDIChannelPacket & -The packet to copy.
const TTime & timeStamp -The time stamp to set.
Channel -The channel to set.
DataIndex length -The length of the data to allocate.

Return Value:

None.

Exceptions:

Throws TMIDIException::kInvalidStatus if not a Channel message.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDIChannelPacket::~TMIDIChannelPacket

virtual ~ TMIDIChannelPacket ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDIChannelPacket::operator=

TMIDIChannelPacket & operator =(const TMIDIChannelPacket &)
TMIDIChannelPacket & operator =(const TMIDIPacket &)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TMIDIChannelPacket & -The object to copy.
const TMIDIPacket & -The object to convert.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws TMIDIException::kInvalidStatus if not a channel message.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDIChannelPacket::GetChannel

Channel GetChannel () const

Interface Category:

API.

Purpose:

Gets the channel.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The channel.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDIChannelPacket::SetChannel

void SetChannel (Channel)

Interface Category:

API.

Purpose:

Sets the channel.

Calling Context:

Call this function directly.

Parameters:

Channel -The channel to set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.