TimerQuery Class Reference

ALSA Timer inquiry helper. More...

#include <alsatimer.h>

List of all members.

Public Member Functions

 TimerQuery (const QString &deviceName, int openMode)
 Constructor.
 TimerQuery (const QString &deviceName, int openMode, snd_config_t *conf)
 Constructor.
virtual ~TimerQuery ()
 Destructor.
TimerIdList getTimers () const
 Gets the list of available timers.
TimerGlobalInfogetGlobalInfo ()
 Get a TimerGlobalInfo object.
void setGlobalParams (snd_timer_gparams_t *params)
 Sets the global parameters.
void getGlobalParams (snd_timer_gparams_t *params)
 Gets the global timer parameters.
void getGlobalStatus (snd_timer_gstatus_t *status)
 Gets the global timer status.

Protected Member Functions

void readTimers ()
 Enumerate the available timers storing the results into an internal list.
void freeTimers ()
 Release the internal list of timers.


Detailed Description

ALSA Timer inquiry helper.

This class provides a mechanism to enumerate the available system timers.

Examples:

sysinfo.cpp.

Definition at line 154 of file alsatimer.h.


Constructor & Destructor Documentation

TimerQuery ( const QString &  deviceName,
int  openMode 
)

Constructor.

Parameters:
deviceName Device name, usually "hw"
openMode Open mode (unknown values)

Definition at line 444 of file alsatimer.cpp.

References CHECK_WARNING, and TimerQuery::readTimers().

TimerQuery ( const QString &  deviceName,
int  openMode,
snd_config_t *  conf 
)

Constructor.

Parameters:
deviceName Device name, usually "hw"
openMode Open mode (unknown values)
conf ALSA configuration object pointer

Definition at line 458 of file alsatimer.cpp.

References CHECK_WARNING, and TimerQuery::readTimers().

~TimerQuery (  )  [virtual]

Destructor.

Definition at line 470 of file alsatimer.cpp.

References TimerQuery::freeTimers().


Member Function Documentation

void freeTimers (  )  [protected]

Release the internal list of timers.

Definition at line 498 of file alsatimer.cpp.

Referenced by TimerQuery::~TimerQuery().

TimerGlobalInfo & getGlobalInfo (  ) 

Get a TimerGlobalInfo object.

Returns:
TimerGlobalInfo object reference

Definition at line 508 of file alsatimer.cpp.

void getGlobalParams ( snd_timer_gparams_t *  params  ) 

Gets the global timer parameters.

Parameters:
params Pointer to an ALSA timer global parameters object

Definition at line 529 of file alsatimer.cpp.

void getGlobalStatus ( snd_timer_gstatus_t *  status  ) 

Gets the global timer status.

Parameters:
status Pointer to an ALSA timer global status object

Definition at line 539 of file alsatimer.cpp.

TimerIdList getTimers (  )  const [inline]

Gets the list of available timers.

Returns:
List of TimerId objects
Examples:
sysinfo.cpp.

Definition at line 164 of file alsatimer.h.

void readTimers (  )  [protected]

Enumerate the available timers storing the results into an internal list.

Definition at line 480 of file alsatimer.cpp.

References TimerId::getClass().

Referenced by TimerQuery::TimerQuery().

void setGlobalParams ( snd_timer_gparams_t *  params  ) 

Sets the global parameters.

Parameters:
params Pointer to an ALSA timer global parameters object

Definition at line 519 of file alsatimer.cpp.


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

Generated on Wed Sep 8 10:12:52 2010 for drumstick by  doxygen 1.5.9