kpilot

KPilotSysInfo Class Reference

#include <pilotSysInfo.h>

List of all members.


Public Member Functions

const unsigned short getCompatMajorVersion () const
const unsigned short getCompatMinorVersion () const
const unsigned long getLocale () const
const unsigned short getMajorVersion () const
const unsigned short getMaxRecSize () const
const unsigned short getMinorVersion () const
const char * getProductID () const
const int getProductIDLength () const
const unsigned long getRomVersion () const
 KPilotSysInfo (const SysInfo *sys_info)
 KPilotSysInfo ()
void setLocale (unsigned long newval)
SysInfo * sysInfo ()

Detailed Description

Definition at line 40 of file pilotSysInfo.h.


Constructor & Destructor Documentation

KPilotSysInfo::KPilotSysInfo (  )  [inline]

Constructor.

Create an empty SysInfo structure.

Definition at line 44 of file pilotSysInfo.h.

KPilotSysInfo::KPilotSysInfo ( const SysInfo *  sys_info  )  [inline]

Constructor.

Copy an existing pilot-link SysInfo structure. Ownership is not changed. sys_info may be NULL.

Definition at line 52 of file pilotSysInfo.h.


Member Function Documentation

const unsigned short KPilotSysInfo::getCompatMajorVersion (  )  const [inline]

Accessor for the major compatibility version of the handheld.

Note:
I do not know what this means.

Definition at line 118 of file pilotSysInfo.h.

const unsigned short KPilotSysInfo::getCompatMinorVersion (  )  const [inline]

Accessor for the minor compatibility version of the handheld.

Note:
I do not know what this means.

Definition at line 125 of file pilotSysInfo.h.

const unsigned long KPilotSysInfo::getLocale (  )  const [inline]

Get the locale number of the handheld.

Note:
I do not know what this means.

Definition at line 79 of file pilotSysInfo.h.

const unsigned short KPilotSysInfo::getMajorVersion (  )  const [inline]

Accessor for the major version of the DLP protocol in use.

Definition at line 105 of file pilotSysInfo.h.

const unsigned short KPilotSysInfo::getMaxRecSize (  )  const [inline]

Returns the maximum record size that the handheld supports.

Normally this is 65524 or so (which means that larger values don't necessarily fit in a short).

Definition at line 135 of file pilotSysInfo.h.

const unsigned short KPilotSysInfo::getMinorVersion (  )  const [inline]

Accessor for the minor version of the DLP protocol in use.

Definition at line 110 of file pilotSysInfo.h.

const char* KPilotSysInfo::getProductID (  )  const [inline]

Get the ProductID string from the handheld.

This is guaranteed to be NUL terminated.

Definition at line 99 of file pilotSysInfo.h.

const int KPilotSysInfo::getProductIDLength (  )  const [inline]

Get the length (in bytes) of the ProductID string.

Definition at line 92 of file pilotSysInfo.h.

const unsigned long KPilotSysInfo::getRomVersion (  )  const [inline]

Get the ROM version of the handheld.

This is a pilot-link long value (4 bytes) with major, minor, bugfix version numbers encoded in the value.

Definition at line 71 of file pilotSysInfo.h.

void KPilotSysInfo::setLocale ( unsigned long  newval  )  [inline]

Set the locale number of the handheld.

Note:
I do not know what this means.

Definition at line 86 of file pilotSysInfo.h.

SysInfo* KPilotSysInfo::sysInfo (  )  [inline]

Access to the raw SysInfo structure.

Definition at line 62 of file pilotSysInfo.h.


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