com.esri.arcgis.carto
Interface IRealTimeFeedSimulator

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRealTimeFeedSimulatorProxy, RealTimeFeedSimulator

public interface IRealTimeFeedSimulator
extends java.io.Serializable

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

Description: 'Provides access to the members of a real-time feed simulator.' 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	IIDa062c77e_53e6_4a6a_8e22_14c7a73540fe
static int	xxDummy Deprecated. Internal use only

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.
java.lang.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(java.lang.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.

Field Detail

IIDa062c77e_53e6_4a6a_8e22_14c7a73540fe

static final int IIDa062c77e_53e6_4a6a_8e22_14c7a73540fe

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

getFeatureLayer

IFeatureLayer getFeatureLayer()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

void setFeatureLayerByRef(IFeatureLayer ppSimulationData)
                          throws java.io.IOException,
                                 AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFixedTime

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

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

Returns:

The pFixed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedTime

void setFixedTime(boolean pFixed)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

pFixed - The pFixed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeIncrement

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

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

Returns:

The pIncrement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeIncrement

void setTimeIncrement(double pIncrement)
                      throws java.io.IOException,
                             AutomationException

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

Parameters:

pIncrement - The pIncrement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeField

java.lang.String getTimeField()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

The pFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeField

void setTimeField(java.lang.String pFieldName)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

pFieldName - The pFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFactor

double getTimeFactor()
                     throws java.io.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.

Returns:

The pFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFactor

void setTimeFactor(double pFactor)
                   throws java.io.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.

Parameters:

pFactor - The pFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.