class PsiTime

Psion time related utility class. More...

List of all Methods
Definition	`#include <lib/psitime.h>`

Annotated List

Files

Globals

Hierarchy

Index

Public Types

enum zone {PSI_TZ_NONE = 0, PSI_TZ_EUROPEAN = 1, PSI_TZ_NORTHERN = 2, PSI_TZ_SOUTHERN = 4, PSI_TZ_HOME = 0x40000000, }

Public Methods

PsiTime (struct timeval *_utv, struct timezone *_utz = 0L)
PsiTime (time_t time)
PsiTime (psi_timeval *_ptv, psi_timezone *_ptz = 0L)
PsiTime (const u_int32_t _ptvHi, const u_int32_t _ptvLo)
PsiTime (void)
PsiTime (const PsiTime &t)
~ PsiTime ()
void setPsiTime (psi_timeval *_ptv)
void setSiboTime (u_int32_t stime)
void setPsiTime (const u_int32_t _ptvHi, const u_int32_t _ptvLo)
void setPsiZone (psi_timezone *_ptz)
void setUnixTime (struct timeval *_utv)
void setUnixTime (time_t time)
void setUnixNow (void)
time_t getTime (void)
u_int32_t getSiboTime ()
psi_timeval & getPsiTimeval (void)
const u_int32_t getPsiTimeLo (void)
const u_int32_t getPsiTimeHi (void)
friend ostream & operator<< (ostream &s, const PsiTime &t)
PsiTime & operator= (const PsiTime &t)
bool operator== (const PsiTime &t)
bool operator< (const PsiTime &t)
bool operator> (const PsiTime &t)

Public Members

Forward timeval

Detailed Description

Psion time related utility class.

PsiTime provides easy access to the time format, used when communicating with a Psion. Internally, the time is always normalized to GMT. The time value can be set and retrieved in both Unix and Psion formats. This allows easy conversion between both formats. NOTE: For proper conversion, the current timezone of the Psion has to be set. For EPOC devices, the timezone can be evaluated using rpcs::getMachineInfo . For SIBO devices, unfortunately there is no known method of retrieving this information. Therefore, if the timezone is not set, a fallback using the environment variable PSI_TZ is provided. Users should set this variable to the offset of their time zone in seconds. If PSI_TZ is net set, a second fallback uses the local machine's setup, which assumes that both Psion and local machine have the same time zone and daylight settings.

PsiTime (struct timeval *_utv, struct timezone *_utz = 0L)

Contructs a new instance.

Parameters:

_utv A Unix time value for initialization.

_utz A Unix timezone for initialization.

PsiTime (time_t time)

Contructs a new instance.

Parameters:

time A Unix time value for initialization.

PsiTime (psi_timeval *_ptv, psi_timezone *_ptz = 0L)

Contructs a new instance.

Parameters:

_ptv A Psion time value for initialization.

_ptz A Psion timezone for initialization.

PsiTime (const u_int32_t _ptvHi, const u_int32_t _ptvLo)

Contructs a new instance.

Parameters:

_ptvHi The high 32 bits of a Psion time value for initialization.

_ptvLo The low 32 bits of a Psion time value for initialization.

PsiTime (void)

Constructs a new instance, initializing to now.

PsiTime (const PsiTime &t)

A copy-constructor

~ PsiTime ()

Destroys the instance.

void setPsiTime (psi_timeval *_ptv)

Modifies the value of this instance.

Parameters:

_ptv The new Psion time representation.

void setSiboTime (u_int32_t stime)

Modifies the value of this instance.

Parameters:

stime The new SIBO time representation.

void setPsiTime (const u_int32_t _ptvHi, const u_int32_t _ptvLo)

Modifies the value of this instance.

Parameters:

_ptvHi The high 32 bits of a Psion time.

_ptvLo The low 32 bits of a Psion time.

void setPsiZone (psi_timezone *_ptz)

Sets the Psion time zone of this instance.

Parameters:

_ptz The new Psion time zone.

void setUnixTime (struct timeval *_utv)

Sets the value of this instance.

Parameters:

_utv The new Unix time representation.

void setUnixTime (time_t time)

Sets the value of this instance.

Parameters:

_utv The new Unix time representation.

void setUnixNow (void)

Sets the value of this instance to the current time of the Unix machine.

time_t getTime (void)

Retrieves the instance's current value in Unix time format.

Returns: The instance's current time as Unix time_t.

u_int32_t getSiboTime ()

Retrieves the instance's current value in SIBO time format.

Returns: The instance's current time as SIBO time.

psi_timeval & getPsiTimeval (void)

Retrieves the instance's current value in Psion time format.

Returns: The instance's current time a Psion struct psi_timeval_t.

const u_int32_t getPsiTimeLo (void)

Retrieves the instance's current value in Psion time format, high 32 bits.

Returns: The instance's current time as lower 32 bits of a Psion struct psi_timeval_t.

const u_int32_t getPsiTimeHi (void)

Retrieves the instance's current value in Psion time format, low 32 bits.

Returns: The instance's current time as upper 32 bits of a Psion struct psi_timeval_t.

friend ostream & operator<< (ostream &s, const PsiTime &t)

Prints the instance's value in human readable format. This function uses the current locale setting for formatting the time.

Parameters:

s The stream to be written.

t The instance whose value should be displayed.

Returns: The stream.

PsiTime & operator= (const PsiTime &t)

Assignment operator

bool operator== (const PsiTime &t)

Comparison operators

bool operator< (const PsiTime &t)

bool operator> (const PsiTime &t)

enum zone {PSI_TZ_NONE = 0, PSI_TZ_EUROPEAN = 1, PSI_TZ_NORTHERN = 2, PSI_TZ_SOUTHERN = 4, PSI_TZ_HOME = 0x40000000, }

Author: Fritz Elfert <felfert@to.com>
Generated: felfert@usw-pr-shell1.sourceforge.net on Sat Aug 10 18:46:04 2002, using kdoc 2.0a36.

_utv	A Unix time value for initialization.
_utz	A Unix timezone for initialization.

_ptv	A Psion time value for initialization.
_ptz	A Psion timezone for initialization.

_ptvHi	The high 32 bits of a Psion time value for initialization.
_ptvLo	The low 32 bits of a Psion time value for initialization.

_ptvHi	The high 32 bits of a Psion time.
_ptvLo	The low 32 bits of a Psion time.

s	The stream to be written.
t	The instance whose value should be displayed.