drumstick  0.5.0
QueueTimer Class Reference

Queue timer container. More...

#include <alsaqueue.h>

Public Member Functions

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

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() [1/2]

QueueTimer ( const QueueTimer other)

Copy constructor.

Parameters
otherAn existing QueueTimer object reference

Definition at line 552 of file alsaqueue.cpp.

◆ QueueTimer() [2/2]

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

◆ clone()

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().

◆ getId()

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.

◆ getInfoSize()

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.

◆ getQueueId()

int getQueueId ( )

The queue's numeric identifier.

Returns
The queue's numeric identifier

Definition at line 590 of file alsaqueue.cpp.

◆ getResolution()

unsigned int getResolution ( )

Gets the timer resolution.

Returns
The timer resolution

Definition at line 625 of file alsaqueue.cpp.

◆ getType()

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.

◆ operator=()

QueueTimer & operator= ( const QueueTimer other)

Assignment operator.

Parameters
otherAn existing QueueTimer object reference
Returns
This object

Definition at line 580 of file alsaqueue.cpp.

◆ setId() [1/2]

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().

◆ setId() [2/2]

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().

◆ setResolution()

void setResolution ( unsigned int  value)

Sets the timer resolution.

Parameters
valueThe timer resolution

Definition at line 669 of file alsaqueue.cpp.

◆ setType()

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: