drumstick 0.5.0
QueueTimer Class Reference

Queue timer container. More...

#include <alsaqueue.h>

List of all members.

Public Member Functions

 QueueTimer ()
 Default constructor.
 QueueTimer (const QueueTimer &other)
 Copy constructor.
 QueueTimer (snd_seq_queue_timer_t *other)
 Constructor.
virtual ~QueueTimer ()
 Destructor.
QueueTimerclone ()
 Copy the current object and return the copy.
QueueTimeroperator= (const QueueTimer &other)
 Assignment operator.
int getInfoSize () const
 Gets the size of the ALSA queue timer object.
int getQueueId ()
 The queue's numeric identifier.
snd_seq_queue_timer_type_t getType ()
 Gets the timer type.
const snd_timer_id_t * getId ()
 Gets the timer identifier record.
unsigned int getResolution ()
 Gets the timer resolution.
void setType (snd_seq_queue_timer_type_t value)
 Sets the timer type.
void setId (snd_timer_id_t *value)
 Sets the timer identifier record.
void setId (const TimerId &id)
 Sets the timer identifier.
void setResolution (unsigned int value)
 Sets the timer resolution.

Detailed Description

Queue timer container.

This class is used to hold some properties about the Timer used with an ALSA queue object.

Examples:

sysinfo.cpp.

Definition at line 157 of file alsaqueue.h.


Constructor & Destructor Documentation

QueueTimer ( const QueueTimer other)

Copy constructor.

Parameters:
otherAn existing QueueTimer object reference

Definition at line 552 of file alsaqueue.cpp.

QueueTimer ( snd_seq_queue_timer_t *  other)

Constructor.

Parameters:
otherAn ALSA queue timer object pointer

Definition at line 542 of file alsaqueue.cpp.


Member Function Documentation

QueueTimer * clone ( )

Copy the current object and return the copy.

Returns:
The pointer to the new object

Definition at line 570 of file alsaqueue.cpp.

References QueueTimer::QueueTimer().

const snd_timer_id_t * getId ( )

Gets the timer identifier record.

Returns:
The timer identifier record pointer
Examples:
sysinfo.cpp.

Definition at line 616 of file alsaqueue.cpp.

int getInfoSize ( ) const

Gets the size of the ALSA queue timer object.

Returns:
The size of the ALSA object

Definition at line 678 of file alsaqueue.cpp.

int getQueueId ( )

The queue's numeric identifier.

Returns:
The queue's numeric identifier

Definition at line 590 of file alsaqueue.cpp.

unsigned int getResolution ( )

Gets the timer resolution.

Returns:
The timer resolution

Definition at line 625 of file alsaqueue.cpp.

snd_seq_queue_timer_type_t getType ( )

Gets the timer type.

The timer type can be one of the following constants:

  • SND_SEQ_TIMER_ALSA: ALSA timer
  • SND_SEQ_TIMER_MIDI_CLOCK: MIDI Clock (CLOCK event)
  • SND_SEQ_TIMER_MIDI_TICK: MIDI Timer Tick (TICK event)
Returns:
the timer type.
See also:
setType()

Definition at line 607 of file alsaqueue.cpp.

QueueTimer & operator= ( const QueueTimer other)

Assignment operator.

Parameters:
otherAn existing QueueTimer object reference
Returns:
This object

Definition at line 580 of file alsaqueue.cpp.

void setId ( snd_timer_id_t *  value)

Sets the timer identifier record.

Parameters:
valueThe timer identifier record pointer

Definition at line 650 of file alsaqueue.cpp.

Referenced by QueueTimer::setId().

void setId ( const TimerId id)

Sets the timer identifier.

Parameters:
idTimer identifier object
Since:
0.3.0

Definition at line 660 of file alsaqueue.cpp.

References QueueTimer::setId().

void setResolution ( unsigned int  value)

Sets the timer resolution.

Parameters:
valueThe timer resolution

Definition at line 669 of file alsaqueue.cpp.

void setType ( snd_seq_queue_timer_type_t  value)

Sets the timer type.

The timer type can be one of the following constants:

  • SND_SEQ_TIMER_ALSA: ALSA timer
  • SND_SEQ_TIMER_MIDI_CLOCK: MIDI Clock (CLOCK event)
  • SND_SEQ_TIMER_MIDI_TICK: MIDI Timer Tick (TICK event)
Parameters:
valueThe timer type
See also:
getType()

Definition at line 641 of file alsaqueue.cpp.


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