com.esri.arcgis.carto
Interface IRealTimeFeedSimulator

All Superinterfaces:

Serializable

All Known Implementing Classes:

RealTimeFeedSimulator

public interface IRealTimeFeedSimulator
extends Serializable

Provides access to the members of a real-time feed simulator.

Product Availability

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

Method Summary

IFeatureLayer	getFeatureLayer() The feature layer used to simulate the real-time feed.
double	getTimeFactor() A factor used to adjust the data-driven time interval.
String	getTimeField() The name of the field used for a data-driven time interval.
double	getTimeIncrement() The time increment, in seconds, for the simulated feed.
boolean	isFixedTime() Indicates if a fixed time interval is used.
void	setFeatureLayerByRef(IFeatureLayer ppSimulationData) The feature layer used to simulate the real-time feed.
void	setFixedTime(boolean pFixed) Indicates if a fixed time interval is used.
void	setTimeFactor(double pFactor) A factor used to adjust the data-driven time interval.
void	setTimeField(String pFieldName) The name of the field used for a data-driven time interval.
void	setTimeIncrement(double pIncrement) The time increment, in seconds, for the simulated feed.

Method Detail

getFeatureLayer

IFeatureLayer getFeatureLayer()
                              throws IOException,
                                     AutomationException

The feature layer used to simulate the real-time feed. This must be a point or line feature layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.carto.IFeatureLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

void setFeatureLayerByRef(IFeatureLayer ppSimulationData)
                          throws IOException,
                                 AutomationException

The feature layer used to simulate the real-time feed. This must be a point or line feature layer.

Product Availability

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

Parameters:

ppSimulationData - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedTime

boolean isFixedTime()
                    throws IOException,
                           AutomationException

Indicates if a fixed time interval is used. If false, use a data-driven time interval. Defaults to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pFixed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedTime

void setFixedTime(boolean pFixed)
                  throws IOException,
                         AutomationException

Indicates if a fixed time interval is used. If false, use a data-driven time interval. Defaults to true.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFixed - The pFixed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeIncrement

double getTimeIncrement()
                        throws IOException,
                               AutomationException

The time increment, in seconds, for the simulated feed. Defaults to 5 seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pIncrement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeIncrement

void setTimeIncrement(double pIncrement)
                      throws IOException,
                             AutomationException

The time increment, in seconds, for the simulated feed. Defaults to 5 seconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pIncrement - The pIncrement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeField

String getTimeField()
                    throws IOException,
                           AutomationException

The name of the field used for a data-driven time interval. Defaults to 'TIME'.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeField

void setTimeField(String pFieldName)
                  throws IOException,
                         AutomationException

The name of the field used for a data-driven time interval. Defaults to 'TIME'.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFieldName - The pFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeFactor

double getTimeFactor()
                     throws IOException,
                            AutomationException

A factor used to adjust the data-driven time interval. The factor is multiplied by each value in the TimeField. Defaults to 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeFactor

void setTimeFactor(double pFactor)
                   throws IOException,
                          AutomationException

A factor used to adjust the data-driven time interval. The factor is multiplied by each value in the TimeField. Defaults to 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pFactor - The pFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.