drumstick  0.5.0
QueueStatus Class Reference

Queue status container. More...

#include <alsaqueue.h>

Public Member Functions

 QueueStatus ()
 Default constructor.
 
 QueueStatus (const QueueStatus &other)
 Copy constructor. More...
 
 QueueStatus (snd_seq_queue_status_t *other)
 Constructor. More...
 
virtual ~QueueStatus ()
 Destructor.
 
QueueStatusclone ()
 Copy the current object and return the copy. More...
 
QueueStatusoperator= (const QueueStatus &other)
 Assignment operator. More...
 
int getInfoSize () const
 Gets the size of the ALSA status object. More...
 
int getId ()
 Gets the queue's numeric identifier. More...
 
int getEvents ()
 Gets the number of queued events. More...
 
const snd_seq_real_time_t * getRealtime ()
 Gets the real time (secods and nanoseconds) of the queue. More...
 
unsigned int getStatusBits ()
 Gets the running status bits. More...
 
bool isRunning ()
 Gets the queue's running state. More...
 
double getClockTime ()
 Gets the clock time in seconds of the queue. More...
 
snd_seq_tick_time_t getTickTime ()
 Gets the musical time (ticks) of the queue. More...
 

Detailed Description

Queue status container.

This class is used to retrieve some status information from an ALSA queue.

Examples
sysinfo.cpp.

Definition at line 80 of file alsaqueue.h.

Constructor & Destructor Documentation

◆ QueueStatus() [1/2]

QueueStatus ( const QueueStatus other)

Copy constructor.

Parameters
otherAn existing QueueStatus object reference

Definition at line 226 of file alsaqueue.cpp.

◆ QueueStatus() [2/2]

QueueStatus ( snd_seq_queue_status_t *  other)

Constructor.

Parameters
otherALSA queue status object pointer

Definition at line 216 of file alsaqueue.cpp.

Member Function Documentation

◆ clone()

QueueStatus * clone ( )

Copy the current object and return the copy.

Returns
The pointer to the new object

Definition at line 244 of file alsaqueue.cpp.

References QueueStatus::QueueStatus().

◆ getClockTime()

double getClockTime ( )

Gets the clock time in seconds of the queue.

Returns
The queue time in seconds
Examples
sysinfo.cpp.

Definition at line 327 of file alsaqueue.cpp.

◆ getEvents()

int getEvents ( )

Gets the number of queued events.

Returns
The number of queued events

Definition at line 273 of file alsaqueue.cpp.

Referenced by SequencerOutputThread::syncOutput().

◆ getId()

int getId ( )

Gets the queue's numeric identifier.

Returns
The queue's numeric identifier.

Definition at line 264 of file alsaqueue.cpp.

◆ getInfoSize()

int getInfoSize ( ) const

Gets the size of the ALSA status object.

Returns
The size of the ALSA object

Definition at line 309 of file alsaqueue.cpp.

◆ getRealtime()

const snd_seq_real_time_t * getRealtime ( )

Gets the real time (secods and nanoseconds) of the queue.

Returns
The queue's real time.

Definition at line 282 of file alsaqueue.cpp.

◆ getStatusBits()

unsigned int getStatusBits ( )

Gets the running status bits.

Returns
The running status bits

Definition at line 291 of file alsaqueue.cpp.

◆ getTickTime()

snd_seq_tick_time_t getTickTime ( )

Gets the musical time (ticks) of the queue.

Returns
The musical time
Examples
sysinfo.cpp.

Definition at line 300 of file alsaqueue.cpp.

◆ isRunning()

bool isRunning ( )

Gets the queue's running state.

Returns
True if the queue is running
Examples
sysinfo.cpp.

Definition at line 318 of file alsaqueue.cpp.

◆ operator=()

QueueStatus & operator= ( const QueueStatus other)

Assignment operator.

Parameters
otherAn existing QueueStatus object reference
Returns
This object

Definition at line 254 of file alsaqueue.cpp.


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