LiveSupport::Scheduler::PlayLogInterface Class Reference

#include <PlayLogInterface.h>

Inheritance diagram for LiveSupport::Scheduler::PlayLogInterface:

[legend]List of all members.

---

Detailed Description

The generic interface for the component scheduling events.

Author:

Author

paul

Version:

Revision

2833

Definition at line 74 of file PlayLogInterface.h.

Public Member Functions
virtual Ptr< UniqueId >::Ref	addPlayLogEntry (Ptr< const UniqueId >::Ref audioClipId, Ptr< const ptime >::Ref timeStamp)=0 throw (std::invalid_argument)
	Add a new entry to the play log.
virtual Ptr< std::vector< Ptr< PlayLogEntry >::Ref > >::Ref	getPlayLogEntries (Ptr< const ptime >::Ref fromTime, Ptr< const ptime >::Ref toTime)=0 throw (std::invalid_argument)
	Return the list of play log entries for a specified time interval.
virtual	~PlayLogInterface (void) throw ()
	A virtual destructor, as this class has virtual functions.

---

Constructor & Destructor Documentation

virtual LiveSupport::Scheduler::PlayLogInterface::~PlayLogInterface

(

void

)

throw () [inline, virtual]

A virtual destructor, as this class has virtual functions.

Definition at line 109 of file PlayLogInterface.h.

---

Member Function Documentation

virtual Ptr<UniqueId>::Ref LiveSupport::Scheduler::PlayLogInterface::addPlayLogEntry	(	Ptr< const UniqueId >::Ref	audioClipId,
		Ptr< const ptime >::Ref	timeStamp
	)			throw (std::invalid_argument) [pure virtual]

Add a new entry to the play log.

Parameters:

	audioClipId	the audio clip played.
	timeStamp	the time the clip was played (started).

Returns:

the id of the newly created play log entry.

Implemented in LiveSupport::Scheduler::PostgresqlPlayLog.

virtual Ptr<std::vector<Ptr<PlayLogEntry>::Ref> >::Ref LiveSupport::Scheduler::PlayLogInterface::getPlayLogEntries	(	Ptr< const ptime >::Ref	fromTime,
		Ptr< const ptime >::Ref	toTime
	)			throw (std::invalid_argument) [pure virtual]

Return the list of play log entries for a specified time interval.

Parameters:

	fromTime	the start of the time of the interval queried, inclusive
	toTime	to end of the time of the interval queried, non-inclusive

Returns:

a vector of the play log entries for the time region.

Implemented in LiveSupport::Scheduler::PostgresqlPlayLog.

---

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

• PlayLogInterface.h

---