Timeline Class Reference

A queue of commands to be fired off on a timer. More...

#include <Timeline.h>

Collaboration diagram for Timeline:

Public Member Functions
	Timeline ()
	~Timeline ()
	Timeline (const Timeline &)=delete
Timeline &	operator= (const Timeline &)=delete
snd_err	Register (AudioCommand *cmd, int t)
	Registers this object. More...
snd_err	Deregister (AudioCommand *cmd)
	Deregisters this object. More...
snd_err	RemovePlaylist (unsigned int instance)
	Removes the playlist described by instance. More...
snd_err	ProcessAlarms ()
	Process the alarms. More...
int	GetTime ()
	Gets the time. More...

Private Attributes
Timer	timer
std::multimap< int, AudioCommand * >	timeline

Friends
class	Alarmable

Detailed Description

A queue of commands to be fired off on a timer.

Author

Jack Campbell

Date

6/1/2017

Constructor & Destructor Documentation

Timeline() [1/2]

Timeline::Timeline

(

)

~Timeline()

Timeline::~Timeline

(

)

Timeline() [2/2]

Timeline::Timeline ( const Timeline &  )

delete

Member Function Documentation

Deregister()

snd_err Timeline::Deregister

(

AudioCommand *

cmd

)

Deregisters this object.

Author

Jack Campbell

Date

6/1/2017

Parameters

[in,out]

cmd

If non-null, the command.

Returns

A snd_err.

GetTime()

int Timeline::GetTime

(

)

Gets the time.

Author

Jack Campbell

Date

6/1/2017

Returns

The time.

operator=()

Timeline& Timeline::operator= ( const Timeline &  )

delete

ProcessAlarms()

snd_err Timeline::ProcessAlarms

(

)

Process the alarms.

Author

Jack Campbell

Date

6/1/2017

Returns

A snd_err.

Register()

snd_err Timeline::Register	(	AudioCommand *	cmd,
		int	t
	)

Registers this object.

Author

Jack Campbell

Date

6/1/2017

Parameters

[in,out]	cmd	If non-null, the command.
	t	The int to process.

Returns

A snd_err.

RemovePlaylist()

snd_err Timeline::RemovePlaylist

(

unsigned int

instance

)

Removes the playlist described by instance.

Author

Jack Campbell

Date

6/1/2017

Parameters

instance

The instance.

Returns

A snd_err.

Friends And Related Function Documentation

Alarmable

friend class Alarmable

friend

Member Data Documentation

timeline

std::multimap<int, AudioCommand*> Timeline::timeline

private

timer

Timer Timeline::timer

private

---

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

• Timeline.h
• Timeline.cpp