com.esri.arcgis.carto
Interface IRealTimeLog

All Superinterfaces:

Serializable

All Known Implementing Classes:

RealTimeFeedManager

public interface IRealTimeLog
extends Serializable

Provides access to members for logging real-time data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

Method Detail

getLogFile

IFeatureClass getLogFile()
                         throws IOException,
                                AutomationException

The feature class used to log positions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogFileByRef

void setLogFileByRef(IFeatureClass ppFeatureClass)
                     throws IOException,
                            AutomationException

The feature class used to log positions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLogRate

double getLogRate()
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogRate

void setLogRate(double pRate)
                throws IOException,
                       AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pRate - The pRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumLogDistance

double getMinimumLogDistance()
                             throws IOException,
                                    AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumLogDistance

void setMinimumLogDistance(double pDistance)
                           throws IOException,
                                  AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pDistance - The pDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumLogDeflectionAngle

double getMinimumLogDeflectionAngle()
                                    throws IOException,
                                           AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumLogDeflectionAngle

void setMinimumLogDeflectionAngle(double pAngle)
                                  throws IOException,
                                         AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAngle - The pAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLogRate

boolean isUseLogRate()
                     throws IOException,
                            AutomationException

Indicates if the log rate is used for sampling data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLogRate

void setUseLogRate(boolean pUse)
                   throws IOException,
                          AutomationException

Indicates if the log rate is used for sampling data.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUse - The pUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDistance

boolean isUseMinimumLogDistance()
                                throws IOException,
                                       AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDistance

void setUseMinimumLogDistance(boolean pUse)
                              throws IOException,
                                     AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUse - The pUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseMinimumLogDeflectionAngle

boolean isUseMinimumLogDeflectionAngle()
                                       throws IOException,
                                              AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseMinimumLogDeflectionAngle

void setUseMinimumLogDeflectionAngle(boolean pUse)
                                     throws IOException,
                                            AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pUse - The pUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startLogging

void startLogging()
                  throws IOException,
                         AutomationException

Start logging to the current log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopLogging

void stopLogging()
                 throws IOException,
                        AutomationException

Stop logging to the current log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLogging

boolean isLogging()
                  throws IOException,
                         AutomationException

Indicates if the data is being logged.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pLogging

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stampGpsPosition

void stampGpsPosition()
                      throws IOException,
                             AutomationException

Stamp current position values to the selected log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLogEstimatedPosition

void setLogEstimatedPosition(boolean pLogEstimated)
                             throws IOException,
                                    AutomationException

Indicates if positions are logged if the signal is lost.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pLogEstimated - The pLogEstimated (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLogEstimatedPosition

boolean isLogEstimatedPosition()
                               throws IOException,
                                      AutomationException

Indicates if positions are logged if the signal is lost.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pLogEstimated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.