com.esri.arcgis.carto
Class RealTimeFeedSimulator

java.lang.Object
  com.esri.arcgis.carto.RealTimeFeedSimulator

All Implemented Interfaces:

IRealTimeFeed, IRealTimeFeedSimulator, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class RealTimeFeedSimulator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRealTimeFeed, IRealTimeFeedSimulator, IPersistStream, IConnectionPointContainer, java.io.Externalizable

COM Class 'RealTimeFeedSimulator'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The real-time feed simulator object.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IRealTimeFeed

IID, IID57736c36_7c6e_4c58_b8cb_b1efb385b47c, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IRealTimeFeedSimulator

IID, IIDa062c77e_53e6_4a6a_8e22_14c7a73540fe, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

RealTimeFeedSimulator()
Constructs a RealTimeFeedSimulator using ArcGIS Engine.

RealTimeFeedSimulator(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RealTimeFeedSimulator theRealTimeFeedSimulator = (RealTimeFeedSimulator) obj;

Method Summary

void	addIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener) addIRealTimeFeedEventsListener.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getConnectionError() Connection error information.
esriGpsDateTime	getCurrentDateTime() The current date and time.
esriGpsDgpsInfo	getCurrentDgpsInfo() The current DGPS information.
esriGpsDOPInfo	getCurrentDopInfo() The current DOP information.
esriGpsGroundCourse	getCurrentGroundCourse() The current ground course.
esriGpsMagneticVariance	getCurrentMagneticVariance() The current magnetic variance.
esriGpsPositionInfo	getCurrentPosition() The current position information from the real-time feed.
int	getCurrentSatelliteCount() The most recent number of satellites.
esriGpsSatelliteData	getCurrentSatelliteData(int index) The satellite data for the given index value.
IFeatureLayer	getFeatureLayer() The feature layer used to simulate the real-time feed.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the real-time feed.
int	getStatus() The current status of 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.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isFixedTime() Indicates if a fixed time interval is used.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a RealTimeFeedSimulator.
void	removeIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener) removeIRealTimeFeedEventsListener.
void	save(IStream pstm, int fClearDirty) save
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	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The spatial reference of the real-time feed.
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.
void	start() Starts the real-time feed.
void	stop() Stops the real-time feed.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RealTimeFeedSimulator

public RealTimeFeedSimulator()
                      throws java.io.IOException,
                             java.net.UnknownHostException

Constructs a RealTimeFeedSimulator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RealTimeFeedSimulator

public RealTimeFeedSimulator(java.lang.Object obj)
                      throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RealTimeFeedSimulator theRealTimeFeedSimulator = (RealTimeFeedSimulator) obj;

Construct a RealTimeFeedSimulator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RealTimeFeedSimulator.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIRealTimeFeedEventsListener

public void addIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener)
                                    throws java.io.IOException

addIRealTimeFeedEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedEvents interface.

Throws:

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

removeIRealTimeFeedEventsListener

public void removeIRealTimeFeedEventsListener(IRealTimeFeedEvents theListener)
                                       throws java.io.IOException

removeIRealTimeFeedEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IRealTimeFeedEvents interface.

Throws:

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

release

public void release()

Release a RealTimeFeedSimulator.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

start

public void start()
           throws java.io.IOException,
                  AutomationException

Starts the real-time feed. If failed and sets error information in 'ConnectionError'.

Specified by:

start in interface IRealTimeFeed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws java.io.IOException,
                 AutomationException

Stops the real-time feed.

Specified by:

stop in interface IRealTimeFeed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The spatial reference of the real-time feed.

Specified by:

getSpatialReference in interface IRealTimeFeed

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws java.io.IOException,
                                     AutomationException

The spatial reference of the real-time feed.

Specified by:

setSpatialReferenceByRef in interface IRealTimeFeed

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

public int getStatus()
              throws java.io.IOException,
                     AutomationException

The current status of the real-time feed.

Specified by:

getStatus in interface IRealTimeFeed

Returns:

A com.esri.arcgis.carto.esriGpsConnectionStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentPosition

public esriGpsPositionInfo getCurrentPosition()
                                       throws java.io.IOException,
                                              AutomationException

The current position information from the real-time feed.

Specified by:

getCurrentPosition in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsPositionInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteCount

public int getCurrentSatelliteCount()
                             throws java.io.IOException,
                                    AutomationException

The most recent number of satellites.

Specified by:

getCurrentSatelliteCount in interface IRealTimeFeed

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSatelliteData

public esriGpsSatelliteData getCurrentSatelliteData(int index)
                                             throws java.io.IOException,
                                                    AutomationException

The satellite data for the given index value.

Specified by:

getCurrentSatelliteData in interface IRealTimeFeed

Parameters:

index - The index (in)

Returns:

A Structure: com.esri.arcgis.carto.esriGpsSatelliteData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentMagneticVariance

public esriGpsMagneticVariance getCurrentMagneticVariance()
                                                   throws java.io.IOException,
                                                          AutomationException

The current magnetic variance.

Specified by:

getCurrentMagneticVariance in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsMagneticVariance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentGroundCourse

public esriGpsGroundCourse getCurrentGroundCourse()
                                           throws java.io.IOException,
                                                  AutomationException

The current ground course.

Specified by:

getCurrentGroundCourse in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsGroundCourse

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDopInfo

public esriGpsDOPInfo getCurrentDopInfo()
                                 throws java.io.IOException,
                                        AutomationException

The current DOP information.

Specified by:

getCurrentDopInfo in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDOPInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDateTime

public esriGpsDateTime getCurrentDateTime()
                                   throws java.io.IOException,
                                          AutomationException

The current date and time.

Specified by:

getCurrentDateTime in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDateTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentDgpsInfo

public esriGpsDgpsInfo getCurrentDgpsInfo()
                                   throws java.io.IOException,
                                          AutomationException

The current DGPS information.

Specified by:

getCurrentDgpsInfo in interface IRealTimeFeed

Returns:

A Structure: com.esri.arcgis.carto.esriGpsDgpsInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionError

public int getConnectionError()
                       throws java.io.IOException,
                              AutomationException

Connection error information.

Specified by:

getConnectionError in interface IRealTimeFeed

Returns:

A com.esri.arcgis.carto.esriGpsConnectionError constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

public 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.

Specified by:

getFeatureLayer in interface IRealTimeFeedSimulator

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

public 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.

Specified by:

setFeatureLayerByRef in interface IRealTimeFeedSimulator

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

public 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.

Specified by:

isFixedTime in interface IRealTimeFeedSimulator

Returns:

The pFixed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFixedTime

public 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.

Specified by:

setFixedTime in interface IRealTimeFeedSimulator

Parameters:

pFixed - The pFixed (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeIncrement

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

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

Specified by:

getTimeIncrement in interface IRealTimeFeedSimulator

Returns:

The pIncrement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeIncrement

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

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

Specified by:

setTimeIncrement in interface IRealTimeFeedSimulator

Parameters:

pIncrement - The pIncrement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeField

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

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

Specified by:

getTimeField in interface IRealTimeFeedSimulator

Returns:

The pFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeField

public 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'.

Specified by:

setTimeField in interface IRealTimeFeedSimulator

Parameters:

pFieldName - The pFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeFactor

public 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.

Specified by:

getTimeFactor in interface IRealTimeFeedSimulator

Returns:

The pFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeFactor

public 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.

Specified by:

setTimeFactor in interface IRealTimeFeedSimulator

Parameters:

pFactor - The pFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException