drumstick  1.1.0
RemoveEvents Class Reference

Auxiliary class to remove events from an ALSA queue. More...

#include <alsaevent.h>

Public Member Functions

 RemoveEvents ()
 Default constructor.
 
 RemoveEvents (const RemoveEvents &other)
 Copy constructor. More...
 
 RemoveEvents (snd_seq_remove_events_t *other)
 Constructor from an ALSA remove events object pointer. More...
 
virtual ~RemoveEvents ()
 Destructor.
 
RemoveEventsclone ()
 Create a new object copied from this object and return a pointer to the copy. More...
 
RemoveEventsoperator= (const RemoveEvents &other)
 Assignment operator. More...
 
int getSizeOfInfo () const
 Gets the allocated size of the ALSA remove events object. More...
 
int getChannel ()
 Gets the MIDI channel. More...
 
unsigned int getCondition ()
 Gets the condition. More...
 
const snd_seq_addr_t * getDest ()
 Gets the destination. More...
 
int getEventType ()
 Gets the event type. More...
 
int getQueue ()
 Gets the queue number. More...
 
int getTag ()
 Gets the numeric tag. More...
 
const snd_seq_timestamp_t * getTime ()
 Gets the timestamp. More...
 
void setChannel (int chan)
 Gets the MIDI channel. More...
 
void setCondition (unsigned int cond)
 Sets the flags of the conditional event's removal. More...
 
void setDest (const snd_seq_addr_t *dest)
 Set the destination address. More...
 
void setEventType (int type)
 Sets the event type. More...
 
void setQueue (int queue)
 Sets the queue number. More...
 
void setTag (int tag)
 Sets the numeric tag. More...
 
void setTime (const snd_seq_timestamp_t *time)
 Sets the timestamp. More...
 

Detailed Description

Auxiliary class to remove events from an ALSA queue.

See Also
MidiClient::removeEvents()

Definition at line 586 of file alsaevent.h.

Constructor & Destructor Documentation

RemoveEvents ( const RemoveEvents other)

Copy constructor.

Parameters
otherAn existing RemoveEvents object reference.

Definition at line 717 of file alsaevent.cpp.

RemoveEvents ( snd_seq_remove_events_t *  other)

Constructor from an ALSA remove events object pointer.

Parameters
otherAn ALSA remove events object pointer.

Definition at line 727 of file alsaevent.cpp.

Member Function Documentation

RemoveEvents * clone ( )

Create a new object copied from this object and return a pointer to the copy.

Returns
A pointer to the new object.

Definition at line 746 of file alsaevent.cpp.

References RemoveEvents::RemoveEvents().

int getChannel ( )

Gets the MIDI channel.

Returns
The MIDI channel.
See Also
setChannel()

Definition at line 779 of file alsaevent.cpp.

unsigned int getCondition ( )

Gets the condition.

Returns
The condition.
See Also
setCondition()

Definition at line 790 of file alsaevent.cpp.

const snd_seq_addr_t * getDest ( )

Gets the destination.

Returns
The destination record pointer.
See Also
setDest()

Definition at line 801 of file alsaevent.cpp.

int getEventType ( )

Gets the event type.

Returns
The event type.
See Also
setEventType()

Definition at line 812 of file alsaevent.cpp.

int getQueue ( )

Gets the queue number.

Returns
The queue number.
See Also
setQueue()

Definition at line 823 of file alsaevent.cpp.

int getSizeOfInfo ( ) const

Gets the allocated size of the ALSA remove events object.

Returns
The size of the ALSA remove events object.

Definition at line 768 of file alsaevent.cpp.

int getTag ( )

Gets the numeric tag.

Returns
The numeric tag.
See Also
setTag()

Definition at line 834 of file alsaevent.cpp.

const snd_seq_timestamp_t * getTime ( )

Gets the timestamp.

Returns
The timestamp.
See Also
setTime()

Definition at line 845 of file alsaevent.cpp.

RemoveEvents & operator= ( const RemoveEvents other)

Assignment operator.

Parameters
otherAn existing RemoveEvents object reference.
Returns
This object.

Definition at line 757 of file alsaevent.cpp.

void setChannel ( int  chan)

Gets the MIDI channel.

Parameters
chanThe MIDI channel.
See Also
getChannel()

Definition at line 856 of file alsaevent.cpp.

void setCondition ( unsigned int  cond)

Sets the flags of the conditional event's removal.

This condition is a bitmap of the combination (OR) the following auto-described flags:

  • SND_SEQ_REMOVE_INPUT
  • SND_SEQ_REMOVE_OUTPUT
  • SND_SEQ_REMOVE_DEST
  • SND_SEQ_REMOVE_DEST_CHANNEL
  • SND_SEQ_REMOVE_TIME_BEFORE
  • SND_SEQ_REMOVE_TIME_AFTER
  • SND_SEQ_REMOVE_TIME_TICK
  • SND_SEQ_REMOVE_EVENT_TYPE
  • SND_SEQ_REMOVE_IGNORE_OFF
  • SND_SEQ_REMOVE_TAG_MATCH
Parameters
condThe condition bitmap.
See Also
getCondition()

Definition at line 880 of file alsaevent.cpp.

void setDest ( const snd_seq_addr_t *  dest)

Set the destination address.

Parameters
destA pointer to the destination address record.
See Also
getDest()

Definition at line 891 of file alsaevent.cpp.

void setEventType ( int  type)

Sets the event type.

Parameters
typeThe event type.
See Also
getEventType()

Definition at line 902 of file alsaevent.cpp.

void setQueue ( int  queue)

Sets the queue number.

Parameters
queueThe queue number.
See Also
getQueue()

Definition at line 913 of file alsaevent.cpp.

void setTag ( int  tag)

Sets the numeric tag.

Parameters
tagThe numeric tag.
See Also
getTag()

Definition at line 924 of file alsaevent.cpp.

void setTime ( const snd_seq_timestamp_t *  time)

Sets the timestamp.

Parameters
timeA pointer to the timestamp record.
See Also
getTime()

Definition at line 935 of file alsaevent.cpp.


The documentation for this class was generated from the following files: