drumstick  1.1.0
TimerInfo Class Reference

ALSA Timer information container. More...

#include <alsatimer.h>

Public Member Functions

 TimerInfo ()
 Constructor.
 
 TimerInfo (const TimerInfo &other)
 Copy constructor. More...
 
 TimerInfo (const snd_timer_info_t *other)
 Cosntructor. More...
 
virtual ~TimerInfo ()
 Destructor.
 
TimerInfoclone ()
 Copy the current object. More...
 
TimerInfooperator= (const TimerInfo &other)
 Assignment operator. More...
 
int getSizeOfInfo () const
 Gets the size of the ALSA timer info object. More...
 
bool isSlave ()
 Check if the timer is slave (depends on another device) More...
 
int getCard ()
 Gets the card number. More...
 
QString getId ()
 Gets the string identifier. More...
 
QString getName ()
 Gets the timer name. More...
 
long getResolution ()
 Gets the timer resolution (timer period in nanoseconds) More...
 
long getFrequency ()
 Gets the timer frequency in Hz. More...
 

Protected Member Functions

long getTicks () __attribute__((deprecated))
 Gets the maximum timer ticks. More...
 

Detailed Description

ALSA Timer information container.

This class is used to hold properties about ALSA Timers.

Examples:
sysinfo.cpp.

Definition at line 47 of file alsatimer.h.

Constructor & Destructor Documentation

◆ TimerInfo() [1/2]

TimerInfo ( const TimerInfo other)

Copy constructor.

Parameters
otherExisting TimerInfo object reference

Definition at line 107 of file alsatimer.cpp.

◆ TimerInfo() [2/2]

TimerInfo ( const snd_timer_info_t *  other)

Cosntructor.

Parameters
otherALSA timer info object pointer

Definition at line 97 of file alsatimer.cpp.

Member Function Documentation

◆ clone()

TimerInfo * clone ( )

Copy the current object.

Returns
Pointer to the new object

Definition at line 126 of file alsatimer.cpp.

References TimerInfo::TimerInfo().

◆ getCard()

int getCard ( )

Gets the card number.

Returns
Card number

Definition at line 157 of file alsatimer.cpp.

Referenced by TimerId::operator=(), and TimerId::TimerId().

◆ getFrequency()

long getFrequency ( )

Gets the timer frequency in Hz.

Returns
Timer frequency in Hz
Examples:
sysinfo.cpp.

Definition at line 197 of file alsatimer.cpp.

References TimerInfo::getResolution().

◆ getId()

QString getId ( )

Gets the string identifier.

Returns
String identifier
Examples:
sysinfo.cpp.

Definition at line 167 of file alsatimer.cpp.

◆ getName()

QString getName ( void  )

Gets the timer name.

Returns
Timer name
Examples:
sysinfo.cpp.

Definition at line 177 of file alsatimer.cpp.

◆ getResolution()

long getResolution ( )

Gets the timer resolution (timer period in nanoseconds)

Returns
Timer resolution in nanos

Definition at line 187 of file alsatimer.cpp.

Referenced by TimerInfo::getFrequency().

◆ getSizeOfInfo()

int getSizeOfInfo ( ) const

Gets the size of the ALSA timer info object.

Returns
Size of the ALSA object

Definition at line 212 of file alsatimer.cpp.

◆ getTicks()

long getTicks ( )
protected

Gets the maximum timer ticks.

Deprecated:
Returns
Maximum timer ticks

Definition at line 223 of file alsatimer.cpp.

◆ isSlave()

bool isSlave ( )

Check if the timer is slave (depends on another device)

Returns
True if the timer is slave
Examples:
sysinfo.cpp.

Definition at line 147 of file alsatimer.cpp.

◆ operator=()

TimerInfo & operator= ( const TimerInfo other)

Assignment operator.

Parameters
otherExisting TimerInfo object reference

Definition at line 136 of file alsatimer.cpp.


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