Public API Reference

                 

---

csTimer Class Reference
[Timer]

Timer is a pseudo-component class which counts time and generates a cscmdTimerPulse command to its parent each time timer crosses bound between two periods. More...

#include <cstimer.h>

Inheritance diagram for csTimer:

List of all members.

Public Methods
	csTimer (csComponent *iParent, unsigned iPeriod)
	Create timer object: the timer is created in running state. More...
virtual bool	HandleEvent (iEvent &Event)
	Handle external events and generate timeouts. More...
void	Stop ()
	Stop timer. More...
void	Restart ()
	Restart timer from period start point. More...
void	Pause (unsigned iPause)
	Pause for specified time. More...
bool	Running ()
	Check if timer is running. More...

---

Detailed Description

Timer is a pseudo-component class which counts time and generates a cscmdTimerPulse command to its parent each time timer crosses bound between two periods.

Timer period can be set either at run time or during object creation. This component is always invisible.

Definition at line 60 of file cstimer.h.

---

Constructor & Destructor Documentation

csTimer::csTimer (  csComponent *    iParent, unsigned    iPeriod )

Create timer object: the timer is created in running state.

---

Member Function Documentation

virtual bool csTimer::HandleEvent (  iEvent &    Event )  [virtual]

Handle external events and generate timeouts. Reimplemented from csComponent.

void csTimer::Pause (  unsigned    iPause )

Pause for specified time.

void csTimer::Restart (    )

Restart timer from period start point.

bool csTimer::Running (    )  [inline]

Check if timer is running. Definition at line 99 of file cstimer.h.

void csTimer::Stop (    )

Stop timer.

---

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

• cstimer.h

---