Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::Event< etype > Struct Template Reference

A scheduled event. More...

#include <Midi.h>

Collaboration diagram for TSE3::Event< etype >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef etype event_type

Public Member Functions

 Event (etype data, Clock time)
int operator< (const Event< etype > &e) const
int operator<= (const Event< etype > &e) const
int operator> (const Event< etype > &e) const
int operator>= (const Event< etype > &e) const
int operator== (const Event< etype > &e) const
bool equals (const Event< etype > &e) const

Public Attributes

etype data
Clock time

Detailed Description

template<class etype>
struct TSE3::Event< etype >

A scheduled event.

An Event is a generic class that can schedule something to a Clock time.

It's comparison operators only compare times, NOT the data contents as well.

Note that the MidiEvent class does not use this as a base class since it is a 'special case'.

This is a value type.

Author:
Pete Goodliffe
Version:
3.00
See also:
Midievent

Clock


Member Typedef Documentation

template<class etype>
typedef etype TSE3::Event< etype >::event_type
 


Constructor & Destructor Documentation

template<class etype>
TSE3::Event< etype >::Event etype  data,
Clock  time
[inline]
 

Creates an Event with the given data and Clock.

Parameters:
data The event data (of template parameter type)
time The event time


Member Function Documentation

template<class etype>
int TSE3::Event< etype >::operator< const Event< etype > &  e  )  const [inline]
 

This comparison operator only compares event times, NOT the data contents.

template<class etype>
int TSE3::Event< etype >::operator<= const Event< etype > &  e  )  const [inline]
 

This comparison operator only compares event times, NOT the data contents.

template<class etype>
int TSE3::Event< etype >::operator> const Event< etype > &  e  )  const [inline]
 

This comparison operator only compares event times, NOT the data contents.

template<class etype>
int TSE3::Event< etype >::operator>= const Event< etype > &  e  )  const [inline]
 

This comparison operator only compares event times, NOT the data contents.

template<class etype>
int TSE3::Event< etype >::operator== const Event< etype > &  e  )  const [inline]
 

This comparison operator only compares event times, NOT the data contents.

template<class etype>
bool TSE3::Event< etype >::equals const Event< etype > &  e  )  const [inline]
 

Compares two Events for equality, checking both the times and the data.


Member Data Documentation

template<class etype>
etype TSE3::Event< etype >::data
 

This event's data.

template<class etype>
Clock TSE3::Event< etype >::time
 

This event's Clock.


The documentation for this struct was generated from the following file:
Generated on Wed May 25 14:46:24 2005 for TSE3 by doxygen 1.3.2