com.esri.arcgis.carto
Interface IRealTimeLog

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRealTimeLogProxy, RealTimeFeedManager

public interface IRealTimeLog
extends java.io.Serializable

COM Interface 'IRealTimeLog'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members for logging real-time data.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID32c1c986_1df2_482f_9a7f_39d2e134e528
static int	xxDummy Deprecated. Internal use only

Method Summary

IFeatureClass	getLogFile() The feature class used to log positions.
double	getLogRate() The time, in seconds, between storing positions in the log file.
double	getMinimumLogDeflectionAngle() The minimum deflection angle to use when deciding when to log points.
double	getMinimumLogDistance() The minimum distance between points before they are logged.
boolean	isLogEstimatedPosition() Indicates if positions are logged if the signal is lost.
boolean	isLogging() Indicates if the data is being logged.
boolean	isUseLogRate() Indicates if the log rate is used for sampling data.
boolean	isUseMinimumLogDeflectionAngle() Indicates if the minimum log deflection angle is used for sampling data.
boolean	isUseMinimumLogDistance() Indicates if the minimum log rate is used for sampling data.
void	setLogEstimatedPosition(boolean pLogEstimated) Indicates if positions are logged if the signal is lost.
void	setLogFileByRef(IFeatureClass ppFeatureClass) The feature class used to log positions.
void	setLogRate(double pRate) The time, in seconds, between storing positions in the log file.
void	setMinimumLogDeflectionAngle(double pAngle) The minimum deflection angle to use when deciding when to log points.
void	setMinimumLogDistance(double pDistance) The minimum distance between points before they are logged.
void	setUseLogRate(boolean pUse) Indicates if the log rate is used for sampling data.
void	setUseMinimumLogDeflectionAngle(boolean pUse) Indicates if the minimum log deflection angle is used for sampling data.
void	setUseMinimumLogDistance(boolean pUse) Indicates if the minimum log rate is used for sampling data.
void	stampGpsPosition() Stamp current position values to the selected log file.
void	startLogging() Start logging to the current log file.
void	stopLogging() Stop logging to the current log file.

Field Detail

IID32c1c986_1df2_482f_9a7f_39d2e134e528

static final int IID32c1c986_1df2_482f_9a7f_39d2e134e528

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getLogFile

IFeatureClass getLogFile()
                         throws java.io.IOException,
                                AutomationException

The feature class used to log positions.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogFileByRef

void setLogFileByRef(IFeatureClass ppFeatureClass)
                     throws java.io.IOException,
                            AutomationException

The feature class used to log positions.

Parameters:

ppFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogRate

double getLogRate()
                  throws java.io.IOException,
                         AutomationException

The time, in seconds, between storing positions in the log file. Defaults to 5 seconds.

Returns:

The pRate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogRate

void setLogRate(double pRate)
                throws java.io.IOException,
                       AutomationException

The time, in seconds, between storing positions in the log file. Defaults to 5 seconds.

Parameters:

pRate - The pRate (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumLogDistance

double getMinimumLogDistance()
                             throws java.io.IOException,
                                    AutomationException

The minimum distance between points before they are logged. Overrides the log rate, if the minimum distance has not been traveled.

Returns:

The pDistance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumLogDistance

void setMinimumLogDistance(double pDistance)
                           throws java.io.IOException,
                                  AutomationException

The minimum distance between points before they are logged. Overrides the log rate, if the minimum distance has not been traveled.

Parameters:

pDistance - The pDistance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumLogDeflectionAngle

double getMinimumLogDeflectionAngle()
                                    throws java.io.IOException,
                                           AutomationException

The minimum deflection angle to use when deciding when to log points.

Returns:

The pAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumLogDeflectionAngle

void setMinimumLogDeflectionAngle(double pAngle)
                                  throws java.io.IOException,
                                         AutomationException

The minimum deflection angle to use when deciding when to log points.

Parameters:

pAngle - The pAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLogRate

boolean isUseLogRate()
                     throws java.io.IOException,
                            AutomationException

Indicates if the log rate is used for sampling data.

Returns:

The pUse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLogRate

void setUseLogRate(boolean pUse)
                   throws java.io.IOException,
                          AutomationException

Indicates if the log rate is used for sampling data.

Parameters:

pUse - The pUse (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDistance

boolean isUseMinimumLogDistance()
                                throws java.io.IOException,
                                       AutomationException

Indicates if the minimum log rate is used for sampling data.

Returns:

The pUse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDistance

void setUseMinimumLogDistance(boolean pUse)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the minimum log rate is used for sampling data.

Parameters:

pUse - The pUse (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDeflectionAngle

boolean isUseMinimumLogDeflectionAngle()
                                       throws java.io.IOException,
                                              AutomationException

Indicates if the minimum log deflection angle is used for sampling data.

Returns:

The pUse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDeflectionAngle

void setUseMinimumLogDeflectionAngle(boolean pUse)
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the minimum log deflection angle is used for sampling data.

Parameters:

pUse - The pUse (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startLogging

void startLogging()
                  throws java.io.IOException,
                         AutomationException

Start logging to the current log file.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopLogging

void stopLogging()
                 throws java.io.IOException,
                        AutomationException

Stop logging to the current log file.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLogging

boolean isLogging()
                  throws java.io.IOException,
                         AutomationException

Indicates if the data is being logged.

Returns:

The pLogging

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stampGpsPosition

void stampGpsPosition()
                      throws java.io.IOException,
                             AutomationException

Stamp current position values to the selected log file.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogEstimatedPosition

void setLogEstimatedPosition(boolean pLogEstimated)
                             throws java.io.IOException,
                                    AutomationException

Indicates if positions are logged if the signal is lost.

Parameters:

pLogEstimated - The pLogEstimated (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLogEstimatedPosition

boolean isLogEstimatedPosition()
                               throws java.io.IOException,
                                      AutomationException

Indicates if positions are logged if the signal is lost.

Returns:

The pLogEstimated

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.