tcTimer Class Reference

#include <Timer.h>

Collaboration diagram for tcTimer:

Public Member Functions
	tcTimer ()
virtual	~tcTimer ()
bool	initializeTimer ()
bool	startTimer (tcTimedObject *apTimedObject, uint32_t anSeconds, uint32_t anNanoseconds, bool abSingleShot=false)
bool	startTimer (tcTimedObject *apTimedObject, std::chrono::microseconds acDuration, bool abSingleShot=false)
bool	isStarted ()
void	stopTimer ()

Constructor & Destructor Documentation

tcTimer()

tcTimer::tcTimer

(

)

~tcTimer()

tcTimer::~tcTimer ( )

virtual

Member Function Documentation

initializeTimer()

bool tcTimer::initializeTimer

(

)

Initialize the timer components

Returns

true if the timer can be started safely; false if it cant.

isStarted()

bool tcTimer::isStarted

(

)

Returns true if the timer is currently running.

Returns

true if the timer is started and running.

startTimer() [1/2]

bool tcTimer::startTimer	(	tcTimedObject *	apTimedObject,
		std::chrono::microseconds	acDuration,
		bool	abSingleShot = false
	)

Starts a timer with the configuration dictated. OVerload.

Parameters

apTimedObject	- the object to call "timerTicked()" on; should not be NULL
acDuration	- duraction between ticks (microsecond resolution)
abSingleShot	- true for a single shot timer.

Returns

true if the timer started successfully.

startTimer() [2/2]

bool tcTimer::startTimer	(	tcTimedObject *	apTimedObject,
		uint32_t	anSeconds,
		uint32_t	anNanoseconds,
		bool	abSingleShot = false
	)

Starts a timer with the configuration dictated.

Parameters

apTimedObject	- the object to call "timerTicked()" on; should not be NULL
anSeconds	- seconds between ticks
anNanoseconds	- nanos between ticks
abSingleShot	- true for a single shot timer.

Returns

true if the timer started successfully.

stopTimer()

void tcTimer::stopTimer

(

)

Stops the currently running timer (if any).

---

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

• /tmp/mitycam_sdk/ARM/camera_software/src/Utility/Timer.h
• /tmp/mitycam_sdk/ARM/camera_software/src/Utility/Timer.cpp