UDK 3.2.7 C/C++ API Reference
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
salhelper::Timer Class Reference

Interface for the Timer and handling the event. More...

#include <timer.hxx>

Inheritance diagram for salhelper::Timer:
salhelper::SimpleReferenceObject

List of all members.

Public Member Functions

 Timer ()
 Constructor.
 Timer (const TTimeValue &Time)
 Constructor.
 Timer (const TTimeValue &Time, const TTimeValue &RepeatTime)
 Constructor.
void start ()
 Start timer.
void stop ()
 Abort timer prematurely.
sal_Bool isTicking () const
 Returns sal_True if timer is running.
sal_Bool isExpired () const
 Is the timer expired?
sal_Bool expiresBefore (const Timer *pTimer) const
 Does pTimer expires before us?
void setAbsoluteTime (const TTimeValue &Time)
 Set the absolute time when the timer should fire.
void setRemainingTime (const TTimeValue &Remaining)
 Set the time to fire to 'now' + Remaining.
void setRemainingTime (const TTimeValue &Remaining, const TTimeValue &Repeat)
 Set the time to fire to 'now' + Remaining with repeat interveal Repeat.
void addTime (const TTimeValue &Time)
 Adds Time to the 'fire time'.
TTimeValue getRemainingTime () const
 Returns the remaining time before timer expiration relative to now.

Protected Member Functions

virtual ~Timer ()
 Destructor.
virtual void onShot ()=0
 What should be done when the 'timer fires'.

Protected Attributes

TTimeValue m_aTimeOut
 holds (initial) exparation time of this timer.
TTimeValue m_aExpired
 holds the time of exparation of this timer.
TTimeValue m_aRepeatDelta
 holds the time interveal of successive expirations.
Timerm_pNext
 Pointer to the next timer (to fire).

Friends

class TimerManager

Detailed Description

Interface for the Timer and handling the event.


Constructor & Destructor Documentation

salhelper::Timer::Timer ( )

Constructor.

salhelper::Timer::Timer ( const TTimeValue Time)

Constructor.

salhelper::Timer::Timer ( const TTimeValue Time,
const TTimeValue RepeatTime 
)

Constructor.

virtual salhelper::Timer::~Timer ( ) [protected, virtual]

Destructor.


Member Function Documentation

void salhelper::Timer::addTime ( const TTimeValue Time)

Adds Time to the 'fire time'.

sal_Bool salhelper::Timer::expiresBefore ( const Timer pTimer) const

Does pTimer expires before us?

TTimeValue salhelper::Timer::getRemainingTime ( ) const

Returns the remaining time before timer expiration relative to now.

sal_Bool salhelper::Timer::isExpired ( ) const

Is the timer expired?

sal_Bool salhelper::Timer::isTicking ( ) const

Returns sal_True if timer is running.

virtual void salhelper::Timer::onShot ( ) [protected, pure virtual]

What should be done when the 'timer fires'.

void salhelper::Timer::setAbsoluteTime ( const TTimeValue Time)

Set the absolute time when the timer should fire.

void salhelper::Timer::setRemainingTime ( const TTimeValue Remaining,
const TTimeValue Repeat 
)

Set the time to fire to 'now' + Remaining with repeat interveal Repeat.

void salhelper::Timer::setRemainingTime ( const TTimeValue Remaining)

Set the time to fire to 'now' + Remaining.

void salhelper::Timer::start ( )

Start timer.

void salhelper::Timer::stop ( )

Abort timer prematurely.


Friends And Related Function Documentation

friend class TimerManager [friend]

Member Data Documentation

holds the time of exparation of this timer.

holds the time interveal of successive expirations.

holds (initial) exparation time of this timer.

Pointer to the next timer (to fire).


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines