.TH "shevek::relative_time" 3 "Wed Jul 9 2014" "libshevek" \" -*- nroff -*-
.ad l
.nh
.SH NAME
shevek::relative_time \- 
.PP
Time interval\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <time\&.hh>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBrelative_time\fP ()"
.br
.RI "\fIThe default constructor creates an interval of 0\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP (timetype \fBdays\fP, int \fBhours\fP, int \fBminutes\fP, int \fBseconds\fP, int \fBnanoseconds\fP=0)"
.br
.RI "\fIConstruct an interval of a given size\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP (timetype \fBseconds\fP, unsigned \fBnanoseconds\fP)"
.br
.RI "\fIFast constructor\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator+\fP (\fBrelative_time\fP that) const "
.br
.RI "\fIAdd two intervals\&. \fP"
.ti -1c
.RI "\fBabsolute_time\fP \fBoperator+\fP (\fBabsolute_time\fP that) const "
.br
.RI "\fIAdd an interval to a moment\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator-\fP (\fBrelative_time\fP that) const "
.br
.RI "\fISubtract two intervals\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator-\fP () const "
.br
.RI "\fINegate an interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator*\fP (float c) const "
.br
.RI "\fIScale an interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator/\fP (float c) const "
.br
.RI "\fIScale an interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP \fBoperator%\fP (\fBrelative_time\fP that) const "
.br
.RI "\fIModulo operator for two intervals\&. \fP"
.ti -1c
.RI "double \fBoperator/\fP (\fBrelative_time\fP that) const "
.br
.RI "\fIDivision of two intervals\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP & \fBoperator+=\fP (\fBrelative_time\fP that)"
.br
.RI "\fIAdd an interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP & \fBoperator-=\fP (\fBrelative_time\fP that)"
.br
.RI "\fISubtract an interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP & \fBoperator*=\fP (float c)"
.br
.RI "\fIScale the interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP & \fBoperator/=\fP (float c)"
.br
.RI "\fIScale the interval\&. \fP"
.ti -1c
.RI "\fBrelative_time\fP & \fBoperator%=\fP (\fBrelative_time\fP that)"
.br
.RI "\fIModulo\&. \fP"
.ti -1c
.RI "bool \fBoperator<\fP (\fBrelative_time\fP that) const "
.br
.RI "\fICompare with another interval\&. \fP"
.ti -1c
.RI "bool \fBoperator>\fP (\fBrelative_time\fP that) const "
.br
.RI "\fICompare with another interval\&. \fP"
.ti -1c
.RI "bool \fBoperator<=\fP (\fBrelative_time\fP that) const "
.br
.RI "\fICompare with another interval\&. \fP"
.ti -1c
.RI "bool \fBoperator>=\fP (\fBrelative_time\fP that) const "
.br
.RI "\fICompare with another interval\&. \fP"
.ti -1c
.RI "bool \fBoperator==\fP (\fBrelative_time\fP that) const "
.br
.ti -1c
.RI "bool \fBoperator!=\fP (\fBrelative_time\fP that) const "
.br
.ti -1c
.RI "unsigned \fBnanoseconds\fP () const "
.br
.RI "\fINumber of nanoseconds\&. \fP"
.ti -1c
.RI "unsigned \fBseconds\fP () const "
.br
.RI "\fINumber of seconds\&. \fP"
.ti -1c
.RI "unsigned \fBminutes\fP () const "
.br
.RI "\fINumber of minutes\&. \fP"
.ti -1c
.RI "unsigned \fBhours\fP () const "
.br
.RI "\fINumber of hours\&. \fP"
.ti -1c
.RI "unsigned \fBdays\fP () const "
.br
.RI "\fINumber of days\&. \fP"
.ti -1c
.RI "bool \fBisnegative\fP () const "
.br
.RI "\fIIs this a negative interval? \fP"
.ti -1c
.RI "timetype \fBtotal\fP () const "
.br
.RI "\fITotal number of seconds, as encoded\&. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBset_digits\fP (unsigned num)"
.br
.RI "\fISet number of digits to use when printing (for fractions of seconds)\&. \fP"
.ti -1c
.RI "static unsigned \fBget_digits\fP ()"
.br
.RI "\fIGet the number of digits that is used when printing\&. \fP"
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "std::ostream & \fBoperator<<\fP (std::ostream &s, \fBrelative_time\fP t)"
.br
.RI "\fIWrite the interval to a std::ostream\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Time interval\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "shevek::relative_time::relative_time (timetypeseconds, unsignednanoseconds)"

.PP
Fast constructor\&. This directly fills the members and is therefore slightly faster than the other constructors\&. However, the others aren't really slow either\&. 
.SH "Member Function Documentation"
.PP 
.SS "bool shevek::relative_time::operator!= (\fBrelative_time\fPthat) const"
Compare two intervals\&. Note that this is rarely a useful operation, because minor errors may be introduced by computations\&. 
.SS "bool shevek::relative_time::operator== (\fBrelative_time\fPthat) const"
Compare two intervals\&. Note that this is rarely a useful operation, because minor errors may be introduced by computations\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for libshevek from the source code\&.