Repeat Class Reference
[Scheduler]

encapsulates repetition information for scheduled events More...

#include <Repeat.h>


Public Member Functions

mrs_natural interval2samples (mrs_real srate)
 convert the repeat interval to a sample count based on the given sample rate
virtual bool repeat ()
 report whether this Repeat specifies another repeat
 Repeat (std::string time_interval, mrs_natural rep_count)
 specify finite repetition
 Repeat (std::string time_interval)
 specify infinite repetition
 Repeat ()
 specify no repetition
void set (bool inf, std::string time_interval, mrs_natural rep_count)
 specify finite repetition


Detailed Description

encapsulates repetition information for scheduled events

Author:
Neil Burroughs inb@cs.uvic.ca

Definition at line 36 of file Repeat.h.


Constructor & Destructor Documentation

Repeat ( std::string  time_interval  ) 

specify infinite repetition

Parameters:
time_interval the interval of time between repetitions

Definition at line 30 of file Repeat.cpp.

Repeat ( std::string  time_interval,
mrs_natural  rep_count 
)

specify finite repetition

Parameters:
time_interval the interval of time between repetitions
rep_count the number of times to repeat

Definition at line 35 of file Repeat.cpp.


Member Function Documentation

mrs_natural interval2samples ( mrs_real  srate  ) 

convert the repeat interval to a sample count based on the given sample rate

Parameters:
srate the sample rate to be used in the conversion
Returns:
the count of samples

Definition at line 57 of file Repeat.cpp.

bool repeat (  )  [virtual]

report whether this Repeat specifies another repeat

Returns:
true if repeat is warranted

Definition at line 41 of file Repeat.cpp.

Referenced by EvEvent::repeat().

void set ( bool  inf,
std::string  time_interval,
mrs_natural  rep_count 
)

specify finite repetition

Parameters:
inf true if repeat is to be infinite which negates rep_count
time_interval the interval of time between repetitions
rep_count the number of times to repeat

Definition at line 49 of file Repeat.cpp.


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

Generated on Wed May 23 00:02:23 2012 for Marsyas by  doxygen 1.5.6