summaryrefslogtreecommitdiffstats
path: root/kpilot/lib/pilotSysInfo.h
blob: 4deb4f1b49844f57d8abc5bfdd2862944af5192a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
#ifndef _KPILOT_SYSINFO_H
#define _KPILOT_SYSINFO_H
/* sysInfo.h			KPilot
**
** Copyright (C) 2003 by Reinhold Kainhofer
**
** Wrapper for pilot-link's SysInfo Structure
*/

/*
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU Lesser General Public License as published by
** the Free Software Foundation; either version 2.1 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Lesser General Public License for more details.
**
** You should have received a copy of the GNU Lesser General Public License
** along with this program in a file called COPYING; if not, write to
** the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
** MA 02110-1301, USA.
*/

/*
** Bug reports and questions can be sent to kde-pim@kde.org
*/

#include <stdlib.h>
#include <string.h>
#include <time.h>

#include <pi-version.h>
#include <pi-dlp.h>



class KPilotSysInfo
{
public:
	/** Constructor. Create an empty SysInfo structure. */
	KPilotSysInfo() 
	{
		::memset(&fSysInfo,0,sizeof(struct SysInfo)); 
	}

	/** Constructor. Copy an existing pilot-link SysInfo structure. 
	 *  Ownership is not changed. @p sys_info may be NULL.
	 */ 
	KPilotSysInfo(const SysInfo *sys_info) 
	{
		::memset(&fSysInfo,0,sizeof(struct SysInfo)); 
		if (sys_info)
		{
			fSysInfo = *sys_info;
		}
	}

	/** Access to the raw SysInfo structure. */
	SysInfo *sysInfo()
	{
		return &fSysInfo;
	}

	/** 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.
	 */
	const unsigned long getRomVersion() const 
	{
		return fSysInfo.romVersion;
	}

	/** Get the locale number of the handheld. 
	 *  @note I do not know what this means.
	 */
	const unsigned long getLocale() const 
	{
		return fSysInfo.locale;
	}
	/** Set the locale number of the handheld.
	 *  @note I do not know what this means.
	 */
	void setLocale(unsigned long newval)
	{
		fSysInfo.locale=newval;
	}

	/** Get the length (in bytes) of the ProductID string. */
	const int getProductIDLength() const
	{
		return fSysInfo.prodIDLength;
	}
	/** Get the ProductID string from the handheld. This is
	 *  guaranteed to be NUL terminated.
	 */
	const char* getProductID() const
	{
		return fSysInfo.prodID;
	}

	/** Accessor for the major version of the DLP protocol in use. */
	const unsigned short getMajorVersion() const 
	{
		return fSysInfo.dlpMajorVersion;
	}
	/** Accessor for the minor version of the DLP protocol in use. */
	const unsigned short getMinorVersion() const 
	{
		return fSysInfo.dlpMinorVersion;
	}

	/** Accessor for the major compatibility version of the handheld.
	 *  @note I do not know what this means.
	 */
	const unsigned short getCompatMajorVersion() const 
	{
		return fSysInfo.compatMajorVersion;
	}
	/** Accessor for the minor compatibility version of the handheld.
	 *  @note I do not know what this means.
	 */
	const unsigned short getCompatMinorVersion() const 
	{
		return fSysInfo.compatMinorVersion;
	}


	/** Returns the maximum record size that the handheld supports.
	 *  Normally this is 65524 or so (which means that larger values
	 *  don't necessarily @em fit in a short).
	 */
	const unsigned short getMaxRecSize() const 
	{
		return fSysInfo.maxRecSize;
	}

private:
	struct SysInfo fSysInfo;
};

#endif