com.partnersoft.io.gps.trimble
Class SSFWriter

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

public class SSFWriter
extends java.lang.Object

This is a smart pointer to a COM object.

Author:

Russell Cagle Copyright 2006 Partner Software, Inc.

Constructor Summary

protected

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

Method Summary

void	AppendSSFFile(java.lang.String directory, java.lang.String filename)
void	AttachToGPSReceiverControl(GPSReceiver receiver)
int	CancelFeature()
int	DetachFromGPSReceiverControl()
void	dispose() Release all the resources associated with this object.
int	EndFeature(java.lang.String comment)
int	EndSSFFile()
protected void	finalize() Just cals dispose().
AntennaSettings	GetAntennaSettings()
float	getAreaLoggingInterval()
CarrierStatus	GetCarrierStatus()
boolean	getEnableNotInFeatureLogging()
float	getLineLoggingInterval()
boolean	getLogCarrier()
boolean	getLogSuperCorrect()
float	getNotInFeatureLoggingInterval()
float	getPointLoggingInterval()
double	GetPredictedPostprocessedAccuracy()
boolean	IsFeatureInProgress()
boolean	IsSSFFileInProgress()
long	NumberOfPositionsLoggedInFeature()
void	SetAntennaSettings(java.lang.String antennaName, int measurementMethod, double heightInMeters)
void	setAreaLoggingInterval(float newval)
void	setEnableNotInFeatureLogging(boolean newval)
void	setLineLoggingInterval(float newval)
void	setLogCarrier(boolean newval)
void	setLogSuperCorrect(boolean newval)
void	setNotInFeatureLoggingInterval(float newval)
void	setPointLoggingInterval(float newval)
int	ShowAntennaSettingsDialog(int lengthUnits)
int	StartFeature(int featureType)
int	StartSSFFile(java.lang.String directory, java.lang.String filename)
int	WriteLineAreaHVOffset(int offsetDirection, float horizontalDistance, float verticalDistance)
int	WriteLineAreaSIOffset(int offsetDirection, float slopeDistance, float inclination)
int	WritePointHVOffset(float bearing, float horizontalDistance, float verticalDistance)
int	WritePointSIOffset(float bearing, float slopeDistance, float inclination)

Methods inherited from class java.lang.Object

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

Constructor Detail

SSFWriter

protected SSFWriter()

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

AppendSSFFile

public void AppendSSFFile(java.lang.String directory,
                          java.lang.String filename)

AttachToGPSReceiverControl

public void AttachToGPSReceiverControl(GPSReceiver receiver)

CancelFeature

public int CancelFeature()

DetachFromGPSReceiverControl

public int DetachFromGPSReceiverControl()

EndFeature

public int EndFeature(java.lang.String comment)

EndSSFFile

public int EndSSFFile()

GetAntennaSettings

public AntennaSettings GetAntennaSettings()

GetCarrierStatus

public CarrierStatus GetCarrierStatus()

GetPredictedPostprocessedAccuracy

public double GetPredictedPostprocessedAccuracy()

IsFeatureInProgress

public boolean IsFeatureInProgress()

IsSSFFileInProgress

public boolean IsSSFFileInProgress()

NumberOfPositionsLoggedInFeature

public long NumberOfPositionsLoggedInFeature()

SetAntennaSettings

public void SetAntennaSettings(java.lang.String antennaName,
                               int measurementMethod,
                               double heightInMeters)

ShowAntennaSettingsDialog

public int ShowAntennaSettingsDialog(int lengthUnits)

StartFeature

public int StartFeature(int featureType)

StartSSFFile

public int StartSSFFile(java.lang.String directory,
                        java.lang.String filename)

WriteLineAreaHVOffset

public int WriteLineAreaHVOffset(int offsetDirection,
                                 float horizontalDistance,
                                 float verticalDistance)

WriteLineAreaSIOffset

public int WriteLineAreaSIOffset(int offsetDirection,
                                 float slopeDistance,
                                 float inclination)

WritePointHVOffset

public int WritePointHVOffset(float bearing,
                              float horizontalDistance,
                              float verticalDistance)

WritePointSIOffset

public int WritePointSIOffset(float bearing,
                              float slopeDistance,
                              float inclination)

getAreaLoggingInterval

public float getAreaLoggingInterval()

setAreaLoggingInterval

public void setAreaLoggingInterval(float newval)

getEnableNotInFeatureLogging

public boolean getEnableNotInFeatureLogging()

setEnableNotInFeatureLogging

public void setEnableNotInFeatureLogging(boolean newval)

getLineLoggingInterval

public float getLineLoggingInterval()

setLineLoggingInterval

public void setLineLoggingInterval(float newval)

getLogCarrier

public boolean getLogCarrier()

setLogCarrier

public void setLogCarrier(boolean newval)

getLogSuperCorrect

public boolean getLogSuperCorrect()

setLogSuperCorrect

public void setLogSuperCorrect(boolean newval)

getNotInFeatureLoggingInterval

public float getNotInFeatureLoggingInterval()

setNotInFeatureLoggingInterval

public void setNotInFeatureLoggingInterval(float newval)

getPointLoggingInterval

public float getPointLoggingInterval()

setPointLoggingInterval

public void setPointLoggingInterval(float newval)

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()."); ssfwriter.dispose(); // Could crash in weird ways.