Class: TMIDINoteOnPacket

Declaration: MIDI.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TMIDIChannelPacket

Inherited By:

None.

Purpose:

Provides convenient access to a MIDI Note On message.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to provide more information.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TMIDINoteOnPacket::TMIDINoteOnPacket

  1. TMIDINoteOnPacket ()
  2. TMIDINoteOnPacket (const TTime & timeStamp, Channel, Note, Velocity)
  3. TMIDINoteOnPacket (const TMIDIPacket &)
  4. TMIDINoteOnPacket (const TMIDINoteOnPacket &)

Interface Category:

API.

Purpose:

  1. Default constructor. The data values are undefined.
  2. Constructor.
  3. Constructor.
  4. Copy constructor.

Calling Context:

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

Parameters:

Return Value:

None.

Exceptions:

  1. Throws no exceptions, passes all exceptions through.
  2. Throws no exceptions, passes all exceptions through.
  3. Throws TMIDIException::kInvalidStatus if not a Note On message.
  4. Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::~TMIDINoteOnPacket

virtual ~ TMIDINoteOnPacket ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::operator=

  1. TMIDINoteOnPacket & operator =(const TMIDINoteOnPacket &)
  2. TMIDINoteOnPacket & operator =(const TMIDIPacket &)

Interface Category:

API.

Purpose:

  1. Assignment operator.
  2. Assignment operator that converts a TMIDIPacket.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

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

Exceptions:

  1. Throws no exceptions, passes all exceptions through.
  2. Throws TMIDIException::kInvalidStatus if not a Note On message.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::GetNote

Note GetNote () const

Interface Category:

API.

Purpose:

Gets the note value.

Calling Context:

Call this function directly.

Parameters:

Return Value:

The note value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::SetNote

void SetNote (Note)

Interface Category:

API.

Purpose:

Sets the note value.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::GetVelocity

Velocity GetVelocity () const

Interface Category:

API.

Purpose:

Gets the velocity.

Calling Context:

Call this function directly.

Parameters:

Return Value:

The velocity value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMIDINoteOnPacket::SetVelocity

void SetVelocity (Velocity)

Interface Category:

API.

Purpose:

Sets the velocity.

Calling Context:

Call this function directly.

Parameters:

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.
Copyright©1995 Taligent,Inc. All rights reserved.