OOScriptTimer Class Reference

#include <OOScriptTimer.h>

Inheritance diagram for OOScriptTimer:

Collaboration diagram for OOScriptTimer:

Instance Methods
(id)	- initWithNextTime:interval:
(id)	- initOneShotTimerWithDelay:
(OOTimeAbsolute)	- nextTime
(BOOL)	- setNextTime:
(OOTimeDelta)	- interval
(void)	- setInterval:
(void)	- timerFired
(BOOL)	- scheduleTimer
(void)	- unscheduleTimer
(BOOL)	- isScheduled
(BOOL)	- isValidForScheduling
(NSComparisonResult)	- compareByNextFireTime:
(void)	- dealloc [implementation]
(NSString *)	- descriptionComponents [implementation]

Class Methods
(void)	+ updateTimers
(void)	+ noteGameReset

Private Attributes
OOTimeAbsolute	_nextTime
OOTimeDelta	_interval
BOOL	_isScheduled
BOOL	_hasBeenRun

Detailed Description

Definition at line 39 of file OOScriptTimer.h.

Method Documentation

compareByNextFireTime:

- (NSComparisonResult) compareByNextFireTime:

(OOScriptTimer *)

other

Definition at line 36 of file OOScriptTimer.m.

                                            :(OOScriptTimer *)other
{
    OOTimeAbsolute      otherTime = -INFINITY;
    
    @try
    {
        if (other != nil)  otherTime = [other nextTime];
    }
    @catch (NSException *exception)
    {
        OOLog(kOOLogException, @"\n\n***** Ignoring Timer Exception: %@ : %@ *****\n\n",[exception name], [exception reason]);
    }
    
    if (_nextTime < otherTime) return NSOrderedAscending;
    else if (_nextTime > otherTime) return NSOrderedDescending;
    else  return NSOrderedSame;
}

References _hasBeenRun, _interval, _nextTime, interval, nextTime, and nil.

Here is the call graph for this function:

dealloc

- (void) dealloc

implementation

Reimplemented in OOJSTimer.

Definition at line 36 of file OOScriptTimer.m.

{
    if (_isScheduled)  [self unscheduleTimer];
    
    [super dealloc];
}

descriptionComponents

- (NSString *) descriptionComponents

implementation

Reimplemented in OOJSTimer.

Definition at line 36 of file OOScriptTimer.m.

{
    NSString                    *intervalDesc = nil;
    
    if (_interval <= 0.0)  intervalDesc = @"one-shot";
    else  intervalDesc = [NSString stringWithFormat:@"interval: %g", _interval];
        
    return [NSString stringWithFormat:@"nextTime: %g, %@, %srunning", _nextTime, intervalDesc, _isScheduled ? "" : "not "];
}

initOneShotTimerWithDelay:

- (id) initOneShotTimerWithDelay:

(OOTimeDelta)

delay

Definition at line 36 of file OOScriptTimer.m.

                                :(OOTimeDelta)delay
{
    return [self initWithNextTime:[UNIVERSE getTime] + delay interval:-1.0];
}

initWithNextTime:interval:

- (id) initWithNextTime:		(OOTimeAbsolute)	nextTime
interval:		(OOTimeDelta)	interval

Definition at line 36 of file OOScriptTimer.m.

                       :(OOTimeAbsolute)nextTime
               interval:(OOTimeDelta)interval
{
    OOTimeAbsolute          now;
    
    if ((self = [super init]))
    {
        if (interval <= 0.0)  interval = -1.0;
        
        now = [UNIVERSE getTime];
        if (nextTime < 0.0)  nextTime = now + interval;
        if (nextTime < now && interval < 0)
        {
            // Negative or old nextTime and negative interval = meaningless.
            [self release];
            self = nil;
        }
        else
        {
            _nextTime = nextTime;
            _interval = interval;
            _hasBeenRun = NO;
        }
    }
    
    return self;
}

interval

- (OOTimeDelta) interval

Definition at line 36 of file OOScriptTimer.m.

{
    return _interval;
}

Referenced by compareByNextFireTime:.

Here is the caller graph for this function:

isScheduled

- (BOOL) isScheduled

Definition at line 36 of file OOScriptTimer.m.

{
    return _isScheduled;
}

isValidForScheduling

- (BOOL) isValidForScheduling

Definition at line 36 of file OOScriptTimer.m.

{
    OOTimeAbsolute      now;
    double              scaled;
    
    now = [UNIVERSE getTime];
    if (_nextTime <= now)
    {
        if (_interval <= 0.0 && _hasBeenRun)  return NO;    // One-shot timer which has expired
        
        // Move _nextTime to the closest future time that's a multiple of _interval
        scaled = (now - _nextTime) / _interval;
        scaled = ceil(scaled);
        _nextTime += scaled * _interval;
        if (_nextTime <= now && _hasBeenRun) 
        {
            // Should only happen if _nextTime is exactly equal to now after previous stuff
            _nextTime += _interval;
        }
    }
    
    return YES;
}

nextTime

- (OOTimeAbsolute) nextTime

Definition at line 36 of file OOScriptTimer.m.

{
    return _nextTime;
}

Referenced by compareByNextFireTime:.

Here is the caller graph for this function:

noteGameReset

+ (void) noteGameReset

Definition at line 36 of file OOScriptTimer.m.

{
    NSArray             *timers = nil;
    OOScriptTimer       *timer = nil;
    
    // Intermediate array is required so we don't get stuck in an endless loop over reinserted timers. Note that -sortedObjects also clears the queue!
    timers = [sTimers sortedObjects];
    foreach (timer, timers)
    {
        timer->_isScheduled = NO;
    }
}

scheduleTimer

- (BOOL) scheduleTimer

Definition at line 36 of file OOScriptTimer.m.

{
    if (_isScheduled)  return YES;
    if (![self isValidForScheduling])  return NO;
    
    if (EXPECT(!sUpdating))
    {
        if (EXPECT_NOT(sTimers == nil))  sTimers = [[OOPriorityQueue alloc] initWithComparator:@selector(compareByNextFireTime:)];
        [sTimers addObject:self];
    }
    else
    {
        if (sDeferredTimers == nil)  sDeferredTimers = [[NSMutableArray alloc] init];
        [sDeferredTimers addObject:self];
    }
    
    _isScheduled = YES;
    return YES;
}

Referenced by TimerConstruct().

Here is the caller graph for this function:

setInterval:

- (void) setInterval:

(OOTimeDelta)

interval

Definition at line 36 of file OOScriptTimer.m.

                   :(OOTimeDelta)interval
{
    if (interval <= 0.0)  interval = -1.0;
    _interval = interval;
}

Referenced by TimerSetProperty().

Here is the caller graph for this function:

setNextTime:

- (BOOL) setNextTime:

(OOTimeAbsolute)

nextTime

Definition at line 36 of file OOScriptTimer.m.

                   :(OOTimeAbsolute)nextTime
{
    if (_isScheduled)  return NO;
    
    _nextTime = nextTime;
    return YES;
}

timerFired

- (void) timerFired

Reimplemented in OOJSTimer.

Definition at line 36 of file OOScriptTimer.m.

{
    OOLogGenericSubclassResponsibility();
}

unscheduleTimer

- (void) unscheduleTimer

Definition at line 36 of file OOScriptTimer.m.

{
    [sTimers removeExactObject:self];
    _isScheduled = NO;
    _hasBeenRun = NO;
}

Referenced by OOJSTimer::dealloc.

Here is the caller graph for this function:

updateTimers

+ (void) updateTimers

Definition at line 36 of file OOScriptTimer.m.

{
    OOScriptTimer       *timer = nil;
    OOTimeAbsolute      now;
    
    sUpdating = YES;
    
    now = [UNIVERSE getTime];
    for (;;)
    {
        timer = [sTimers peekAtNextObject];
        if (timer == nil || now < [timer nextTime])  break;
        
        [sTimers removeNextObject];
        
        // Must fire before rescheduling so that the timer callback can stop itself. -- Ahruman 2011-01-01
        [timer timerFired];
        
        timer->_hasBeenRun = YES;
        
        if (timer->_isScheduled)
        {
            timer->_isScheduled = NO;
            [timer scheduleTimer];
        }
    }
    
    if (sDeferredTimers != nil)
    {
        [sTimers addObjects:sDeferredTimers];
        DESTROY(sDeferredTimers);
    }
    
    sUpdating = NO;
}

Member Data Documentation

_hasBeenRun

- (BOOL) _hasBeenRun

private

Definition at line 45 of file OOScriptTimer.h.

Referenced by compareByNextFireTime:.

_interval

- (OOTimeDelta) _interval

private

Definition at line 43 of file OOScriptTimer.h.

Referenced by compareByNextFireTime:.

_isScheduled

- (BOOL) _isScheduled

private

Definition at line 44 of file OOScriptTimer.h.

_nextTime

- (OOTimeAbsolute) _nextTime

private

Definition at line 42 of file OOScriptTimer.h.

Referenced by compareByNextFireTime:.

---

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

• src/Core/Scripting/OOScriptTimer.h
• src/Core/Scripting/OOScriptTimer.m