PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PFrequencyTime Struct Reference

Class wrapper of PTimeInterval to initialise to a frequency. More...

#include <timeint.h>

Inheritance diagram for PFrequencyTime:
Collaboration diagram for PFrequencyTime:

Public Member Functions

 PFrequencyTime (double frequency)
 
- Public Member Functions inherited from PTimeInterval
PObjectClone () const
 Create a new copy of the time interval. More...
 
virtual Comparison Compare (const PObject &obj) const
 Rank the two time intervals. More...
 
virtual void PrintOn (ostream &strm) const
 Output the time interval to the I/O stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the time interval from the I/O stream. More...
 
bool operator== (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator== (long msecs) const
 
bool operator!= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator!= (long msecs) const
 
bool operator> (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator> (long msecs) const
 
bool operator>= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator>= (long msecs) const
 
bool operator< (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator< (long msecs) const
 
bool operator<= (const PTimeInterval &interval) const
 Compare to the two time intervals. More...
 
bool operator<= (long msecs) const
 
PString AsString (int decimals=3, Formats format=NormalFormat, int width=1) const
 Output the time interval as a string. More...
 
PInt64 GetNanoSeconds () const
 Get the number of nanoseconds for the time interval. More...
 
void SetNanoSeconds (int64_t nsecs, int secs=0)
 Set the number of nanoseconds for the time interval. More...
 
PInt64 GetMicroSeconds () const
 Get the number of microseconds for the time interval. More...
 
void SetMicroSeconds (int64_t usecs, int secs=0)
 Set the number of microseconds for the time interval. More...
 
double GetFrequency () const
 Get time interval as a frequency. More...
 
void SetFrequency (double frequency)
 Set time interval from a frequency. More...
 
PInt64 GetMilliSeconds () const
 Get the number of milliseconds for the time interval. More...
 
void SetMilliSeconds (PInt64 msecs)
 Set the number of milliseconds for the time interval. More...
 
long GetSeconds () const
 Get the number of whole seconds for the time interval. More...
 
double GetSecondsAsDouble () const
 Get the number of seconds, and partial seconds, as floating point, for the time interval. More...
 
void SetSeconds (double secs)
 Set the number of seconds for the time interval. More...
 
long GetMinutes () const
 Get the number of whole minutes for the time interval. More...
 
int GetHours () const
 Get the number of whole hours for the time interval. More...
 
int GetDays () const
 Get the number of whole days for the time interval. More...
 
IntervalType GetInterval () const
 Get the "clamped" number of milliseconds for the time interval. More...
 
void SetInterval (PInt64 milliseconds=0, long seconds=0, long minutes=0, long hours=0, int days=0)
 Set the value of the time interval. More...
 
 PTimeInterval (PInt64 millisecs=0)
 Create a new time interval object. More...
 
 PTimeInterval (PInt64 millisecs, long seconds, long minutes=0, long hours=0, int days=0)
 
 PTimeInterval (const PString &str)
 
 PTimeInterval (const PTimeInterval &other)
 
PTimeIntervaloperator= (const PTimeInterval &other)
 
PTimeInterval operator- () const
 Unary minus, get negative of time interval. More...
 
PTimeInterval operator+ (const PTimeInterval &interval) const
 Add the two time intervals yielding a third time interval. More...
 
PTimeIntervaloperator+= (const PTimeInterval &interval)
 Add the second time interval to the first time interval. More...
 
PTimeInterval operator- (const PTimeInterval &interval) const
 Subtract the two time intervals yielding a third time interval. More...
 
PTimeIntervaloperator-= (const PTimeInterval &interval)
 Subtract the second time interval from the first time interval. More...
 
PTimeInterval operator* (int factor) const
 Multiply the time interval by a factor yielding a third time interval. More...
 
PTimeIntervaloperator*= (int factor)
 Multiply the time interval by a factor. More...
 
int operator/ (const PTimeInterval &smaller) const
 Divide the time interval by another interval yielding a count. More...
 
PTimeInterval operator/ (int factor) const
 Divide the time interval by a factor yielding a third time interval. More...
 
PTimeIntervaloperator/= (int factor)
 Divide the time interval by a factor. More...
 
- Public Member Functions inherited from PObject
__inline unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
__inline void SetTraceContextIdentifier (unsigned id)
 
__inline void SetTraceContextIdentifier (const PObject &obj)
 
__inline void SetTraceContextIdentifier (const PObject *obj)
 
__inline void CopyTraceContextIdentifier (PObject &obj) const
 
__inline void CopyTraceContextIdentifier (PObject *obj) const
 
virtual ~PObject ()
 
__inline const char * GetClass () const
 
__inline bool IsClass (const char *name) const
 
__inline const PObjectPTraceObjectInstance () const
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Additional Inherited Members

- Public Types inherited from PTimeInterval
enum  Formats { NormalFormat, IncludeDays, SecondsOnly, SecondsSI }
 
typedef int IntervalType
 
- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PTimeInterval
static PTimeInterval NanoSeconds (int64_t nsecs, int secs=0)
 Return a PTimeInterval in nanoseconds. More...
 
static PTimeInterval MicroSeconds (int64_t usecs, int secs=0)
 Return a PTimeInterval in microseconds. More...
 
static PTimeInterval Seconds (double secs)
 Return a PTimeInterval in seconds. More...
 
static PTimeInterval Frequency (double frequency)
 Return a PTimeInterval from a frequency. More...
 
- Static Public Member Functions inherited from PObject
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject *from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject *from)
 
static __inline const char * Class ()
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
template<typename T >
static Comparison Compare2 (T v1, T v2)
 Compare two types, returning Comparison type. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Static Public Attributes inherited from PTimeInterval
static int64_t const MicroToNano = 1000
 
static int64_t const MilliToNano = MicroToNano*1000
 
static int64_t const SecsToNano = MilliToNano*1000
 
static int64_t const MinsToNano = SecsToNano*60
 
static int64_t const HoursToNano = MinsToNano*60
 
static int64_t const DaysToNano = HoursToNano*24
 
- Protected Member Functions inherited from PTimeInterval
virtual int64_t InternalGet () const
 
virtual void InternalSet (int64_t t)
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Detailed Description

Class wrapper of PTimeInterval to initialise to a frequency.

Constructor & Destructor Documentation

PFrequencyTime::PFrequencyTime ( double  frequency)
inline

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