Description
Used to specify GPS preferences and script subroutines to call when GPS events occur.
Diagram
Overview
 |
GPS
Used to specify GPS preferences and script subroutines to call when GPS events occur.
 |
antennaheight optional xs:double
Specifies the GPS antenna height. This value is subtracted from the incoming GPS position's height to yield the height of the ground below the GPS antenna.
|
|
autoactivate optional Restriction of xs:string
Flag that determines whether the GPS is activated automatically when a map is opened.
|
|
autopan optional Restriction of xs:string
Flag that determines whether the map automatically pans to keep the GPS position centered when GPS is active.
|
|
autopanmargin optional xs:string
Specifies the percentage towards the edge of the screen that the GPS cursor must reach before the map is automatically panned when autopan is active.
|
|
checksum optional Restriction of xs:string
Flag that determines whether the checksum value of incoming GPS messages are verified.
|
|
datum optional xs:string
The datum of the incoming GPS coordinates.
|
|
geoidseparation optional xs:double
Specifies the geoid separation for the current location.
|
|
initialize optional xs:string
Initialization string to send to the GPS upon activation.
|
|
log optional Restriction of xs:string
Code that determines whether the raw GPS data is not logged (1), logged to a new file whenever the GPS is activate (2), or appended to the current log file (3).
|
|
logfile optional xs:string
The log file where raw GPS data from the GPS receiver is stored.
|
|
magneticdeclination optional xs:double
Specifies the magnetic declination for the GPS when the north reference is magnetic north.
|
|
northreference optional Restriction of xs:string
Specifies whether the default GPS north reference is based on true or magnetic north.
|
|
protocol optional Restriction of xs:string
The GPS protocol to use.
|
|
useheight optional Restriction of xs:string
Flag that determines whether the GPS height is used in the datum transformation.
|
|
onaveragestart optional
Specify the script to run when this event occurs.
|
|
onaveragestop optional
Specify the script to run when this event occurs.
|
|
onclose optional
Specify the script to run when this event occurs.
|
|
onexevent optional
Specify the script to run when this event occurs.
|
|
onopen optional
Specify the script to run when this event occurs.
|
|
onposition optional
Specify the script to run when this event occurs.
|
|
onsentence optional
Specify the script to run when this event occurs.
|
 |
Sequence
 |
AVERAGING
Used to specify the averaging settings for the GPS capture settings in ArcPadPrefs.apx.
|
|
COMPORT
Used to define serial port settings for the AUX or GPS port in ArcPadPrefs.apx.
|
|
HEIGHT
Used to specify height settings for the GPS in ArcPadPrefs.apx.
|
|
QUALITYCONTROL
Used to define GPS quality control settings in ArcPadPrefs.apx.
|
|
STREAMING
Used to specify the streaming interval settings for the GPS capture settings in ArcPadPrefs.apx.
|
|
DISPLAY
Used to define display settings in ArcPadPrefs.apx.
|
|
|
Attributes
| Name | Type | Use | Default | Fixed | Description |
|---|
| antennaheight | xs:double | optional | 0.0 | | Specifies the GPS antenna height. This value is subtracted from the incoming GPS position's height to yield the height of the ground below the GPS antenna. |
| autoactivate | Restriction of xs:string | optional | false | | Flag that determines whether the GPS is activated automatically when a map is opened. |
| autopan | Restriction of xs:string | optional | false | | Flag that determines whether the map automatically pans to keep the GPS position centered when GPS is active. |
| autopanmargin | xs:string | optional | | | Specifies the percentage towards the edge of the screen that the GPS cursor must reach before the map is automatically panned when autopan is active. |
| checksum | Restriction of xs:string | optional | false | | Flag that determines whether the checksum value of incoming GPS messages are verified. |
| datum | xs:string | optional | | | The datum of the incoming GPS coordinates. |
| geoidseparation | xs:double | optional | 0.0 | | Specifies the geoid separation for the current location. |
| initialize | xs:string | optional | | | Initialization string to send to the GPS upon activation. |
| log | Restriction of xs:string | optional | 0 | | Code that determines whether the raw GPS data is not logged (1), logged to a new file whenever the GPS is activate (2), or appended to the current log file (3). |
| logfile | xs:string | optional | | | The log file where raw GPS data from the GPS receiver is stored. |
| magneticdeclination | xs:double | optional | 0.0 | | Specifies the magnetic declination for the GPS when the north reference is magnetic north. |
| northreference | Restriction of xs:string | optional | magnetic | | Specifies whether the default GPS north reference is based on true or magnetic north. |
| protocol | Restriction of xs:string | optional | | | The GPS protocol to use. |
| useheight | Restriction of xs:string | optional | | | Flag that determines whether the GPS height is used in the datum transformation. |
| onaveragestart | | optional | | | Specify the script to run when this event occurs. |
| onaveragestop | | optional | | | Specify the script to run when this event occurs. |
| onclose | | optional | | | Specify the script to run when this event occurs. |
| onexevent | | optional | | | Specify the script to run when this event occurs. |
| onopen | | optional | | | Specify the script to run when this event occurs. |
| onposition | | optional | | | Specify the script to run when this event occurs. |
| onsentence | | optional | | | Specify the script to run when this event occurs. |
Remarks
Examples
Source
<xs:element name="GPS" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:annotation>
<xs:documentation>Used to specify GPS preferences and script subroutines to call when GPS events occur.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="pre:AVERAGING" />
<xs:element ref="pre:COMPORT" />
<xs:element ref="pre:HEIGHT" />
<xs:element ref="pre:QUALITYCONTROL" />
<xs:element ref="pre:STREAMING" />
<xs:element ref="pre:DISPLAY" />
</xs:sequence>
<xs:attribute default="0.0" name="antennaheight" type="xs:double">
<xs:annotation>
<xs:documentation>Specifies the GPS antenna height. This value is subtracted from the incoming GPS position's height to yield the height of the ground below the GPS antenna.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="autoactivate">
<xs:annotation>
<xs:documentation>Flag that determines whether the GPS is activated automatically when a map is opened.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="true" />
<xs:enumeration value="false" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute default="false" name="autopan">
<xs:annotation>
<xs:documentation>Flag that determines whether the map automatically pans to keep the GPS position centered when GPS is active.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="true" />
<xs:enumeration value="false" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="autopanmargin" type="xs:string">
<xs:annotation>
<xs:documentation>Specifies the percentage towards the edge of the screen that the GPS cursor must reach before the map is automatically panned when autopan is active.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="checksum">
<xs:annotation>
<xs:documentation>Flag that determines whether the checksum value of incoming GPS messages are verified.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="true" />
<xs:enumeration value="false" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="datum" type="xs:string">
<xs:annotation>
<xs:documentation>The datum of the incoming GPS coordinates.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="0.0" name="geoidseparation" type="xs:double">
<xs:annotation>
<xs:documentation>Specifies the geoid separation for the current location.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="initialize" type="xs:string">
<xs:annotation>
<xs:documentation>Initialization string to send to the GPS upon activation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="0" name="log">
<xs:annotation>
<xs:documentation>Code that determines whether the raw GPS data is not logged (1), logged to a new file whenever the GPS is activate (2), or appended to the current log file (3).</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="0" />
<xs:enumeration value="1" />
<xs:enumeration value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="logfile" type="xs:string">
<xs:annotation>
<xs:documentation>The log file where raw GPS data from the GPS receiver is stored.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="0.0" name="magneticdeclination" type="xs:double">
<xs:annotation>
<xs:documentation>Specifies the magnetic declination for the GPS when the north reference is magnetic north.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="magnetic" name="northreference">
<xs:annotation>
<xs:documentation>Specifies whether the default GPS north reference is based on true or magnetic north.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="magnetic" />
<xs:enumeration value="true" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="protocol">
<xs:annotation>
<xs:documentation>The GPS protocol to use.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="NMEA" />
<xs:enumeration value="TSIP" />
<xs:enumeration value="EART" />
<xs:enumeration value="PLGR" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="useheight">
<xs:annotation>
<xs:documentation>Flag that determines whether the GPS height is used in the datum transformation.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="true" />
<xs:enumeration value="false" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="onaveragestart">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onaveragestop">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onclose">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onexevent">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onopen">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onposition">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="onsentence">
<xs:annotation>
<xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element> |
See Also
