TimerStatus Class Reference

ALSA Timer status container. More...

#include <alsatimer.h>

List of all members.

Public Member Functions

 TimerStatus ()
 Default constructor.
 TimerStatus (const TimerStatus &other)
 Copy constructor.
 TimerStatus (const snd_timer_status_t *other)
 Constructor.
virtual ~TimerStatus ()
 Destructor.
TimerStatusclone ()
 Copy the current object.
TimerStatusoperator= (const TimerStatus &other)
 Assignment operator.
int getSizeOfInfo () const
 Gets the size of the ALSA timer status object.
snd_htimestamp_t getTimestamp ()
 Gets the high resolution time-stamp.
long getResolution ()
 Gets the resolution in us.
long getLost ()
 Gets the master tick lost count.
long getOverrun ()
 Gets the overrun count.
long getQueue ()
 Gets the count of used queue elements.

Friends

class Timer


Detailed Description

ALSA Timer status container.

This class provides some status information about a Timer.

Examples:

timertest.cpp.

Definition at line 220 of file alsatimer.h.


Constructor & Destructor Documentation

TimerStatus (  ) 

Default constructor.

Definition at line 906 of file alsatimer.cpp.

Referenced by TimerStatus::clone().

TimerStatus ( const TimerStatus other  ) 

Copy constructor.

Parameters:
other Existing TimerStatus object reference

Definition at line 925 of file alsatimer.cpp.

TimerStatus ( const snd_timer_status_t *  other  ) 

Constructor.

Parameters:
other Pointer to an existing ALSA timer status object

Definition at line 915 of file alsatimer.cpp.

~TimerStatus (  )  [virtual]

Destructor.

Definition at line 934 of file alsatimer.cpp.


Member Function Documentation

TimerStatus * clone (  ) 

Copy the current object.

Returns:
Pointer to the new object

Definition at line 944 of file alsatimer.cpp.

References TimerStatus::TimerStatus().

long getLost (  ) 

Gets the master tick lost count.

Returns:
Master tick lost count

Definition at line 986 of file alsatimer.cpp.

long getOverrun (  ) 

Gets the overrun count.

Returns:
Overrun count

Definition at line 996 of file alsatimer.cpp.

long getQueue (  ) 

Gets the count of used queue elements.

Returns:
Count of used queue elements

Definition at line 1006 of file alsatimer.cpp.

long getResolution (  ) 

Gets the resolution in us.

Returns:
Resolution in us

Definition at line 976 of file alsatimer.cpp.

int getSizeOfInfo (  )  const

Gets the size of the ALSA timer status object.

Returns:
Size of the ALSA object

Definition at line 1016 of file alsatimer.cpp.

snd_htimestamp_t getTimestamp (  ) 

Gets the high resolution time-stamp.

Returns:
High resolution time-stamp

Definition at line 966 of file alsatimer.cpp.

Referenced by Timer::startEvents().

TimerStatus & operator= ( const TimerStatus other  ) 

Assignment operator.

Parameters:
other Existing TimerStatus object reference
Returns:
This object

Definition at line 955 of file alsatimer.cpp.


Friends And Related Function Documentation

friend class Timer [friend]

Definition at line 222 of file alsatimer.h.


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