Class: TMIDINoteOffPacket

Declaration: MIDI.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMIDIChannelPacket

Inherited By:

None.

Purpose:

Provides convenient access for MIDI Note Off packets.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to add more information.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMIDINoteOffPacket::TMIDINoteOffPacket

TMIDINoteOffPacket ()
TMIDINoteOffPacket (const TTime & timeStamp, Channel, Note, Velocity)
TMIDINoteOffPacket (const TMIDIPacket &)
TMIDINoteOffPacket (const TMIDINoteOffPacket &)

Interface Category:

API.

Purpose:

Default constructor.
Constructor with initial values.
Constructor to convert a TMIDIPacket object.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create an undefined object.
Call this function directly.
Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
const TTime & timeStamp -The time stamp.
Channel -The channel.
Note -The note.
Velocity -The velocity.
const TMIDIPacket & -The packet to convert.
const TMIDINoteOffPacket & -The packet to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.
Throws TMIDIException if the packet is not a Note Off packet.
Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOffPacket::~TMIDINoteOffPacket

virtual ~ TMIDINoteOffPacket ()

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: TMIDINoteOffPacket::operator=

TMIDINoteOffPacket & operator =(const TMIDINoteOffPacket &)
TMIDINoteOffPacket & operator =(const TMIDIPacket &)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator to convert a TMIDIPacket object.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TMIDINoteOffPacket & -The source object for the assignment.
const TMIDIPacket & -The packet to assign and 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 Note Off packet.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOffPacket::GetNote

Note GetNote () const

Interface Category:

API.

Purpose:

Gets the note.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The note value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOffPacket::SetNote

void SetNote (Note)

Interface Category:

API.

Purpose:

Sets the note.

Calling Context:

Call this function directly.

Parameters:

Note -The note value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOffPacket::GetVelocity

Velocity GetVelocity () const

Interface Category:

API.

Purpose:

Gets the velocity.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The velocity value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOffPacket::SetVelocity

void SetVelocity (Velocity)

Interface Category:

API.

Purpose:

Sets the velocity.

Calling Context:

Call this function directly.

Parameters:

Velocity -The velocity value.

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.