20.10.2013 - Modified PIObject - virtual debugName() for macro piCoutObj, improved timer measurements and timers on Windows

pitimer.h

@@ -33,37 +33,100 @@ typedef void (*TimerEvent)(void * , int );
 
 class PIP_EXPORT PISystemTime {
 public:
+	
+	//! Contructs system time with s = ns = 0
 	PISystemTime() {seconds = nanoseconds = 0;}
+	
+	//! Contructs system time with s = "s" and ns = "ns"
 	PISystemTime(long s, long ns) {seconds = s; nanoseconds = ns; checkOverflows();}
+	
+	//! Contructs system time from another
 	PISystemTime(const PISystemTime & t) {seconds = t.seconds; nanoseconds = t.nanoseconds;}
 	
+	
+	//! Returns stored system time value in seconds
 	double toSeconds() const {return double(seconds) + nanoseconds / 1.e+9;}
+	
+	//! Returns stored system time value in milliseconds
 	double toMilliseconds() const {return seconds * 1.e+3 + nanoseconds / 1.e+6;}
+	
+	//! Returns stored system time value in microseconds
 	double toMicroseconds() const {return seconds * 1.e+6 + nanoseconds / 1.e+3;}
+	
+	//! Returns stored system time value in nanoseconds
 	double toNanoseconds() const {return seconds * 1.e+9 + double(nanoseconds);}
+	
+	
+	//! Add to stored system time "v" seconds
 	PISystemTime & addSeconds(double v) {*this += fromSeconds(v); return *this;}
+	
+	//! Add to stored system time "v" milliseconds
 	PISystemTime & addMilliseconds(double v) {*this += fromMilliseconds(v); return *this;}
+	
+	//! Add to stored system time "v" microseconds
 	PISystemTime & addMicroseconds(double v) {*this += fromMicroseconds(v); return *this;}
+	
+	//! Add to stored system time "v" nanoseconds
 	PISystemTime & addNanoseconds(double v) {*this += fromNanoseconds(v); return *this;}
+	
+	
+	//! Sleep for stored value. \warning Use this function to sleep for difference of system times or constructs system time.
+	//! If you call this function on system time returned from \a currentSystemTime() thread will be sleep almost forever.
 	void sleep() {piUSleep(piFloord(toMicroseconds()));} // wait self value, useful to wait some dT = (t1 - t0)
+	
+	
+	//! Returns copy of this system time with absolutely values of s and ns
 	PISystemTime abs() const {return PISystemTime(piAbsl(seconds), piAbsl(nanoseconds));}
+	
+	//! Returns sum of this system time with "t"
 	PISystemTime   operator +(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds += t.seconds; tt.nanoseconds += t.nanoseconds; tt.checkOverflows(); return tt;}
+	
+	//! Returns difference between this system time and "t"
 	PISystemTime   operator -(const PISystemTime & t) {PISystemTime tt(*this); tt.seconds -= t.seconds; tt.nanoseconds -= t.nanoseconds; tt.checkOverflows(); return tt;}
+	
+	//! Add to stored value system time "t"
 	PISystemTime & operator +=(const PISystemTime & t) {seconds += t.seconds; nanoseconds += t.nanoseconds; checkOverflows(); return *this;}
+	
+	//! Subtract from stored value system time "t"
 	PISystemTime & operator -=(const PISystemTime & t) {seconds -= t.seconds; nanoseconds -= t.nanoseconds; checkOverflows(); return *this;}
+	
+	
+	//! Compare system times
 	bool operator ==(const PISystemTime & t) {return ((seconds == t.seconds) && (nanoseconds == t.nanoseconds));}
+	
+	//! Compare system times
 	bool operator !=(const PISystemTime & t) {return ((seconds != t.seconds) || (nanoseconds != t.nanoseconds));}
+	
+	//! Compare system times
 	bool operator >(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds > t.nanoseconds; return seconds > t.seconds;}
+	
+	//! Compare system times
 	bool operator <(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds < t.nanoseconds; return seconds < t.seconds;}
+	
+	//! Compare system times
 	bool operator >=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds >= t.nanoseconds; return seconds >= t.seconds;}
+	
+	//! Compare system times
 	bool operator <=(const PISystemTime & t) {if (seconds == t.seconds) return nanoseconds <= t.nanoseconds; return seconds <= t.seconds;}
 	
+	
+	//! Contructs system time from seconds "v"
 	static PISystemTime fromSeconds(double v) {long s = piFloord(v); return PISystemTime(s, (v - s) * 1000000000);}
+	
+	//! Contructs system time from milliseconds "v"
 	static PISystemTime fromMilliseconds(double v) {long s = piFloord(v / 1000.); return PISystemTime(s, (v / 1000. - s) * 1000000000);}
+	
+	//! Contructs system time from microseconds "v"
 	static PISystemTime fromMicroseconds(double v) {long s = piFloord(v / 1000000.); return PISystemTime(s, (v / 1000000. - s) * 1000000000);}
+	
+	//! Contructs system time from nanoseconds "v"
 	static PISystemTime fromNanoseconds(double v) {long s = piFloord(v / 1000000000.); return PISystemTime(s, (v / 1000000000. - s) * 1000000000);}
 	
+	
+	//! Seconds of stored system time
 	long seconds;
+	
+	//! Nanoseconds of stored system time
 	long nanoseconds;
 	
 private:
@@ -71,7 +134,10 @@ private:
 	
 };
 
+//! \relatesalso PISystemTime \relatesalso PIByteArray \brief Output operator to PIByteArray
 inline PIByteArray & operator <<(PIByteArray & s, const PISystemTime & v) {s << v.seconds << v.nanoseconds; return s;}
+
+//! \relatesalso PISystemTime \relatesalso PIByteArray \brief Input operator from PIByteArray
 inline PIByteArray & operator >>(PIByteArray & s, PISystemTime & v) {s >> v.seconds >> v.nanoseconds; return s;}
 
 struct PIP_EXPORT PITime {
@@ -174,7 +240,8 @@ public:
 	
 	EVENT_HANDLER0(void, reset) {
 #  ifdef WINDOWS
-		t_st = GetCurrentTime();
+		//t_st = GetCurrentTime();
+		pc_st = __PIQueryPerformanceCounter();
 #  elif defined(MAC_OS)
 		clock_get_time(__pi_mac_clock, &t_st);
 #  else
@@ -358,6 +425,7 @@ private:
 	double interval_;
 
 #ifdef WINDOWS
+	llong pc_st, pc_cur, tt_st, tt_cur;
 	long
 #elif defined(MAC_OS)
 	mach_timespec_t
@@ -386,6 +454,8 @@ extern PITimer::TimerPool * pool;
 PIP_EXPORT PITime currentTime();
 PIP_EXPORT PIDate currentDate();
 PIP_EXPORT PIDateTime currentDateTime();
+
+//! \relatesalso PISystemTime \brief Returns current system time
 PIP_EXPORT PISystemTime currentSystemTime();
 PIP_EXPORT PIString time2string(const PITime & time, const PIString & format = "h:mm:ss"); // obsolete, use PITime.toString() instead
 PIP_EXPORT PIString date2string(const PIDate & date, const PIString & format = "d.MM.yyyy"); // obsolete, use PITime.toString() instead