_07_alarme_class.alarm Class Reference

Builds an alarm for playing a music (mp3 file) at a pre-determined time. More...

Classes
class	makeThread
	Class for creating a new thread. More...

Public Member Functions
def	__init__ (self, loc, h=12, m=0)
def	__del__ (self)
def	setTime (self, h=12, m=0)
def	getTime (self)
def	__start__ (self)
def	trigger (self)
	Creates a thread to run the alarm. More...
def	off (self)
def	play (self)
def	__kill__ (self, pid)
def	stop (self)
def	setSong (self, file)
def	getInitialDir (self)
def	getPlayer (self)
def	getdPlayer (self)
def	setPlayer (self, plid)

Static Public Attributes
bool	debug = False

Private Attributes
	__player
	it can be anything More...
	__hour
	hour to start the alarm More...
	__minute
	minute to stop the alarm More...
	__pp
	player process More...
	__pid
	process id of the running player More...
	__tid
	thread id of the alarm More...
	__on
	alarm state: ON or OFF More...
	__useThreading
	selects the threading model More...
	__loc
	locale information More...
	__root
	the root of the music directory More...
	__dplayer
	__song
	__fplayer

Detailed Description

Builds an alarm for playing a music (mp3 file) at a pre-determined time.

Constructor & Destructor Documentation

__init__()

def _07_alarme_class.alarm.__init__	(		self,
			loc,
			h = 12,
			m = 0
	)

Constructor. Sets the starting time.

__del__()

def _07_alarme_class.alarm.__del__

(

self

)

Destructor. Stops the music, before quitting.

References _07_alarme_class.alarm.stop().

Member Function Documentation

__kill__()

def _07_alarme_class.alarm.__kill__	(		self,
			pid
	)

kill function for Win32

Referenced by _07_alarme_class.alarm.stop().

__start__()

def _07_alarme_class.alarm.__start__

(

self

)

Triggers the alarm.

References _07_alarme_class.alarm.__hour, _07_alarme_class.alarm.__minute, _07_alarme_class.alarm.__on, _07_alarme_class.alarm.__pid, _07_alarme_class.alarm.__tid, _07_alarme_class.alarm.getTime(), and _07_alarme_class.alarm.play().

Referenced by _07_alarme_class.alarm.trigger().

getdPlayer()

def _07_alarme_class.alarm.getdPlayer

(

self

)

Returns the player dictionary.

References _07_alarme_class.alarm.__dplayer.

getInitialDir()

def _07_alarme_class.alarm.getInitialDir

(

self

)

Returns an initial directory for searching songs.

References _07_alarme_class.alarm.__root.

getPlayer()

def _07_alarme_class.alarm.getPlayer

(

self

)

Returns an appropriate player based on the OS.

References _07_alarme_class.alarm.__player.

getTime()

def _07_alarme_class.alarm.getTime

(

self

)

Returns the current time: hour and minute.

Referenced by _07_alarme_class.alarm.__start__().

off()

def _07_alarme_class.alarm.off

(

self

)

Turms the alarm off, by killing the thread.

References _07_alarme_class.alarm.__on, and _07_alarme_class.alarm.__tid.

play()

def _07_alarme_class.alarm.play

(

self

)

Plays the current song, in its own process.

References _07_alarme_class.alarm.__fplayer, _07_alarme_class.alarm.__loc, _07_alarme_class.alarm.__pid, _07_alarme_class.alarm.__pp, _07_alarme_class.alarm.__song, and _07_alarme_class.alarm.stop().

Referenced by _07_alarme_class.alarm.__start__().

setPlayer()

def _07_alarme_class.alarm.setPlayer	(		self,
			plid
	)

Sets the player to be used.

setSong()

def _07_alarme_class.alarm.setSong	(		self,
			file
	)

Selects the music to be played.

setTime()

def _07_alarme_class.alarm.setTime	(		self,
			h = 12,
			m = 0
	)

Sets a new starting time.

References _07_alarme_class.alarm.__hour, and _07_alarme_class.alarm.__minute.

stop()

def _07_alarme_class.alarm.stop

(

self

)

Stops the song, by killing the player process.

References _07_alarme_class.alarm.__fplayer, _07_alarme_class.alarm.__kill__(), _07_alarme_class.alarm.__loc, _07_alarme_class.alarm.__pid, _07_alarme_class.alarm.__pp, and _07_alarme_class.alarm.__tid.

Referenced by _07_alarme_class.alarm.__del__(), _11_tkradio.FMRec.__del__(), _07_alarme_class.alarm.play(), _08a_pack_circles.Timer.restart(), and _11_tkradio.FMRec.run().

trigger()

def _07_alarme_class.alarm.trigger

(

self

)

Creates a thread to run the alarm.

Creates a thread to run the alarm.

References _07_alarme_class.alarm.__on, _07_alarme_class.alarm.__start__(), _07_alarme_class.alarm.__tid, and _07_alarme_class.alarm.__useThreading.

Member Data Documentation

__dplayer

_07_alarme_class.alarm.__dplayer

private

Referenced by _07_alarme_class.alarm.getdPlayer().

__fplayer

_07_alarme_class.alarm.__fplayer

private

Referenced by _07_alarme_class.alarm.play(), and _07_alarme_class.alarm.stop().

__hour

_07_alarme_class.alarm.__hour

private

hour to start the alarm

Referenced by _07_alarme_class.alarm.__start__(), _08b_clock_bezier._hand.getCurveData(), and _07_alarme_class.alarm.setTime().

__loc

_07_alarme_class.alarm.__loc

private

locale information

Referenced by _07_alarme_class.volume.getVolume(), _07_alarme_class.alarm.play(), _07_alarme_class.volume.setChannel(), _07_alarme_class.volume.setVolume(), and _07_alarme_class.alarm.stop().

__minute

_07_alarme_class.alarm.__minute

private

minute to stop the alarm

Referenced by _07_alarme_class.alarm.__start__(), _08b_clock_bezier._hand.getCurveData(), and _07_alarme_class.alarm.setTime().

__on

_07_alarme_class.alarm.__on

private

alarm state: ON or OFF

Referenced by _07_alarme_class.alarm.__start__(), _07_alarme_class.alarm.off(), _11_tkradio.IRRec.run(), _11_tkradio.FMRec.run(), _11_tkradio.IRRec.stop(), _11_tkradio.FMRec.stop(), and _07_alarme_class.alarm.trigger().

__pid

_07_alarme_class.alarm.__pid

private

process id of the running player

Referenced by _07_alarme_class.alarm.__start__(), _07_alarme_class.alarm.play(), _11_tkradio.FMRec.run(), _07_alarme_class.alarm.stop(), and _11_tkradio.FMRec.stop().

__player

_07_alarme_class.alarm.__player

private

it can be anything

Referenced by _07_alarme_class.alarm.getPlayer().

__pp

_07_alarme_class.alarm.__pp

private

player process

Referenced by _07_alarme_class.alarm.play(), and _07_alarme_class.alarm.stop().

__root

_07_alarme_class.alarm.__root

private

the root of the music directory

Referenced by _07_alarme_class.alarm.getInitialDir().

__song

_07_alarme_class.alarm.__song

private

Referenced by _07_alarme_class.alarm.play().

__tid

_07_alarme_class.alarm.__tid

private

thread id of the alarm

Referenced by _07_alarme_class.alarm.__start__(), _07_alarme_class.alarm.off(), _07_alarme_class.alarm.stop(), and _07_alarme_class.alarm.trigger().

__useThreading

_07_alarme_class.alarm.__useThreading

private

selects the threading model

Referenced by _07_alarme_class.alarm.trigger().

debug

bool _07_alarme_class.alarm.debug = False

static

Referenced by _08b_clock_bezier.makeThread.__del__(), _08c_clock.makeThread.__del__(), digitalClock.makeThread.__del__(), _08b_clock_bezier.makeThread.run(), _08c_clock.makeThread.run(), and digitalClock.makeThread.run().

---

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

• _07_alarme_class.py