man SbTime () - class for representation of a time
NAME
SbTime - class for representation of a time
INHERITS FROM
SbTime
SYNOPSIS
#include <Inventor/SbTime.h>
Methods from class SbTime:
c
}
c
}
SbTime()
c
}
c
}
SbTime(double sec)
c
}
c
}
SbTime(int32_t sec, long usec)
c
}
c
}
SbTime(const struct timeval *tv)
c
}
c
}
getTimeOfDay()
c
}
c
}
setToTimeOfDay()
c
}
c
}
zero()
c
}
c
}
max()
c
}
c
}
setValue(double sec)
c
}
c
}
setValue(int32_t sec, long usec)
c
}
c
}
setValue(const struct timeval *tv)
c
}
c
}
setMsecValue(unsigned long msec)
c
}
c
}
getValue() const
c
}
c
}
getValue(int32_t &sec, long &usec) const
c
}
c
}
getValue(struct timeval *tv) const
c
}
c
}
getMsecValue() const
c
}
c
}
format(const char *fmt = "%S.%i") const
c
}
c
}
formatDate(const char *fmt = "%A, %D %r") const
c
}
c
}
operator +(const SbTime &t0, const SbTime &t1)
c
}
c
}
operator -(const SbTime &t0, const SbTime &t1)
c
}
c
}
operator +=(const SbTime &tm)
c
}
c
}
operator -=(const SbTime &tm)
c
}
c
}
operator -() const
c
}
c
}
operator *(double s, const SbTime &tm)
c
}
c
}
operator *(const SbTime &tm, double s)
c
}
c
}
operator /(const SbTime &tm, double s)
c
}
c
}
operator *=(double s)
c
}
c
}
operator /=(double s)
c
}
c
}
operator /(const SbTime &tm) const
c
}
c
}
operator %(const SbTime &tm) const
c
}
c
}
operator ==(const SbTime &tm) const
c
}
c
}
operator !=(const SbTime &tm) const
c
}
c
}
operator <(const SbTime &tm) const
c
}
c
}
operator >(const SbTime &tm) const
c
}
c
}
operator <=(const SbTime &tm) const
c
}
c
}
operator >=(const SbTime &tm) const
DESCRIPTION
This class represents and performs operations on time. Operations may be done in seconds, seconds and microseconds, or using a struct timeval (defined in /usr/include/sys/time.h).
METHODS
c
}
c
}
SbTime()
c
}
c
}
SbTime(double sec)
c
}
c
}
SbTime(int32_t sec, long usec)
c
}
c
}
SbTime(const struct timeval *tv)
Constructors taking seconds, seconds and microseconds, or a struct timeval. NOTE that an integer parameter will not automatically cast to a double to invoke the constructor taking seconds; that is, SbTime(1) will result in a compilation error. SbTime(1.0) must be used instead. This is to avoid errors
in upgrading from an earlier release, in which SbTime(1) had different semantics. In future releases, this distinction will be eliminated, and the effect of SbTime(1.0) and that of SbTime(1) will be identical.
c
}
c
}
getTimeOfDay()
Get the current time (seconds since Jan 1, 1970).
c
}
c
}
setToTimeOfDay()
Set to the current time (seconds since Jan 1, 1970).
c
}
c
}
zero()
Get a zero time.
c
}
c
}
max()
Get a time far, far into the future.
c
}
c
}
setValue(double sec)
Set time from a double (in seconds).
c
}
c
}
setValue(int32_t sec, long usec)
Set time from seconds + microseconds.
c
}
c
}
setValue(const struct timeval *tv)
Set time from a struct timeval.
c
}
c
}
setMsecValue(unsigned long msec)
Set time from milliseconds.
c
}
c
}
getValue() const
Get time in seconds as a double.
c
}
c
}
getValue(int32_t &sec, long &usec) const
Get time in seconds and microseconds.
c
}
c
}
getValue(struct timeval *tv) const
Get time in a struct timeval.
c
}
c
}
getMsecValue() const
Get time in milliseconds (for Xt).
c
}
c
}
format(const char *fmt = "%S.%i") const
Convert to a string. The default format is seconds with 3 digits of fraction precision. fmt is a character string that consists of field descriptors and text characters, in a manner analogous to cftime (3C) and printf (3S). Each
field descriptor consists of a % character followed by another character which specifies the replacement for the field descriptor. All other characters are copied from fmt into the result. The following
field descriptors are supported:
% the `%' character D total number of days H total number of hours M total number of minutes S total number of seconds I total number of milliseconds U total number of microseconds h hours remaining after the days (00-23) m minutes remaining after the hours (00-59) s seconds remaining after the minutes (00-59) i milliseconds remaining after the seconds (000-999) u microseconds remaining after the seconds (000000-999999)
The uppercase descriptors are formatted with a leading `-' for negative times; the lowercase descriptors are formatted fixed width, with leading zeros. For example,
a reasonable format string might be "elapsed time: %M minutes, %s seconds". The default value of fmt, "%S.%i", formats the time as seconds with 3 digits of fractional precision.
c
}
c
}
formatDate(const char *fmt = "%A, %D %r") const
Convert to a date string, interpreting the time as seconds since Jan 1, 1970. The default format gives "Tuesday, 01/26/93 11:23:41 AM". See the cftime() reference page for explanation of the format string.
c
}
c
}
operator +(const SbTime &t0, const SbTime &t1)
c
}
c
}
operator -(const SbTime &t0, const SbTime &t1)
Addition and subtraction of two times.
c
}
c
}
operator +=(const SbTime &tm)
c
}
c
}
operator -=(const SbTime &tm)
Addition and subtraction of two times which modifies the time structure.
c
}
c
}
operator -() const
Unary negation.
c
}
c
}
operator *(double s, const SbTime &tm)
c
}
c
}
operator *(const SbTime &tm, double s)
c
}
c
}
operator /(const SbTime &tm, double s)
Multiplication and division by scalar.
c
}
c
}
operator *=(double s)
c
}
c
}
operator /=(double s)
Destructive multiplication and division by scalar.
c
}
c
}
operator /(const SbTime &tm) const
Division by another time.
c
}
c
}
operator %(const SbTime &tm) const
Modulus for two times (remainder when time1 is divided by time2).
c
}
c
}
operator ==(const SbTime &tm) const
c
}
c
}
operator !=(const SbTime &tm) const
Equality operators.
c
}
c
}
operator <(const SbTime &tm) const
c
}
c
}
operator >(const SbTime &tm) const
c
}
c
}
operator <=(const SbTime &tm) const
c
}
c
}
operator >=(const SbTime &tm) const
Relational operators.
SEE ALSO
cftime