com.partnersoft.io.gps.trimble
Class GPSReceiver

java.lang.Object
  com.partnersoft.io.gps.trimble.GPSReceiver

public class GPSReceiver
extends java.lang.Object

Maps to the PFTGPSReceiver ActiveX control.

Author:

Russell Cagle Copyright 2006 Partner Software, Inc.

Constructor Summary

protected

GPSReceiver() Either creates the COM object or throws an exception.

Method Summary

void	AboutBox()
void	DisableDebugLog()
void	dispose() Release all the resources associated with this object.
void	EnableDebugLog(java.lang.String path)
protected void	finalize() Just cals dispose().
AntennaStatus	GetAntennaStatus()
BatteryLevel	GetBatteryLevel()
java.lang.String	getCommPort()
GPSConstellation	GetConstellationInformation()
CourseAndSpeed	GetCourseAndSpeed()
float	getCourseAndSpeedMinimumInterval()
int	getDOPType()
GPSStatus	GetGPSStatus()
float	getMaximumHDOPMask()
float	getMaximumPDOPMask()
float	getMinimumElevationAngleMask()
int	getMinimumNumberOfSatellites()
float	getMinimumSNRMask()
GPSPosition	GetPosition()
float	getPositionMinimumInterval()
GPSReceiverIdentification	GetReceiverIdentification()
SimulationSettings	getSimulationSettings()
boolean	getVelocityFilter()
boolean	IsTracking()
boolean	ResetGPSReceiver()
void	setCommPort(java.lang.String portName)
void	setCourseAndSpeedMinimumInterval(float seconds)
void	setDOPType(int dopType)
void	setMaximumHDOPMask(float max)
void	setMaximumPDOPMask(float max)
void	setMinimumElevationAngleMask(float min)
void	setMinimumNumberOfSatellites(int min)
void	setMinimumSNRMask(float min)
void	setPositionMinimumInterval(float min)
void	setVelocityFilter(boolean filter)
boolean	ShowPropertyPages()
boolean	StartTracking()
boolean	StopTracking()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPSReceiver

protected GPSReceiver()

Either creates the COM object or throws an exception.

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Just cals dispose().

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

AboutBox

public void AboutBox()

DisableDebugLog

public void DisableDebugLog()

EnableDebugLog

public void EnableDebugLog(java.lang.String path)

GetAntennaStatus

public AntennaStatus GetAntennaStatus()

GetBatteryLevel

public BatteryLevel GetBatteryLevel()

GetConstellationInformation

public GPSConstellation GetConstellationInformation()

GetCourseAndSpeed

public CourseAndSpeed GetCourseAndSpeed()

GetGPSStatus

public GPSStatus GetGPSStatus()

GetPosition

public GPSPosition GetPosition()

GetReceiverIdentification

public GPSReceiverIdentification GetReceiverIdentification()

IsTracking

public boolean IsTracking()

ResetGPSReceiver

public boolean ResetGPSReceiver()

ShowPropertyPages

public boolean ShowPropertyPages()

StartTracking

public boolean StartTracking()

StopTracking

public boolean StopTracking()

getCommPort

public java.lang.String getCommPort()

setCommPort

public void setCommPort(java.lang.String portName)

Parameters:

portName - COM1, COM2, etc...

getCourseAndSpeedMinimumInterval

public float getCourseAndSpeedMinimumInterval()

setCourseAndSpeedMinimumInterval

public void setCourseAndSpeedMinimumInterval(float seconds)

getDOPType

public int getDOPType()

setDOPType

public void setDOPType(int dopType)

getMaximumHDOPMask

public float getMaximumHDOPMask()

setMaximumHDOPMask

public void setMaximumHDOPMask(float max)

Parameters:

max - between 1-99.

getMaximumPDOPMask

public float getMaximumPDOPMask()

setMaximumPDOPMask

public void setMaximumPDOPMask(float max)

Parameters:

max - between 1-99.

getMinimumElevationAngleMask

public float getMinimumElevationAngleMask()

setMinimumElevationAngleMask

public void setMinimumElevationAngleMask(float min)

Parameters:

min - between 0-90.

getMinimumNumberOfSatellites

public int getMinimumNumberOfSatellites()

setMinimumNumberOfSatellites

public void setMinimumNumberOfSatellites(int min)

Parameters:

min - between 4-5.

getMinimumSNRMask

public float getMinimumSNRMask()

setMinimumSNRMask

public void setMinimumSNRMask(float min)

Parameters:

min - between 20-47.

getPositionMinimumInterval

public float getPositionMinimumInterval()

setPositionMinimumInterval

public void setPositionMinimumInterval(float min)

Parameters:

min - between 20-47.

getSimulationSettings

public SimulationSettings getSimulationSettings()

getVelocityFilter

public boolean getVelocityFilter()

setVelocityFilter

public void setVelocityFilter(boolean filter)

dispose

public void dispose()

Release all the resources associated with this object. It's advisable to call this method in a deterministic way rather than let finalize call it, because if there is an error in this function that crashes the VM, a deterministic error would be easier to track down. log.info("About to call dispose()."); receiver.dispose(); // Could crash in weird ways.