org.commonreality.sensors.xml
Class XMLSensor

java.lang.Object
  org.commonreality.participant.impl.AbstractParticipant
      org.commonreality.sensors.AbstractSensor
          org.commonreality.sensors.xml.XMLSensor

All Implemented Interfaces:

java.io.Serializable, IIdentifiable, IParticipant, ISensor

public class XMLSensor
extends AbstractSensor

Author:

developer

See Also:

Serialized Form

Field Summary

static java.lang.String

DATA_URL

Constructor Summary

XMLSensor()

Method Summary

void	configure(java.util.Map<java.lang.String,java.lang.String> options)
void	executeFrameNow(org.w3c.dom.Element element) will process the frame data immediately in the current thread.
java.lang.String	getName()
boolean	hasPendingTimeFrames()
void	initialize() called in response to a command from Reality to get everything ready to run.
void	queueFrame(org.w3c.dom.Element element)
void	queueNextFrame()
void	shutdown()
void	start() called to actually start this participant
void	stop() called when this participant needs to stop

Methods inherited from class org.commonreality.sensors.AbstractSensor

connect, disconnect, getAddressingInformation, getAfferentObjectManager, getCredentials, getEfferentObjectManager, getInterfacedAgents, getRealObjectManager, setCredentials, setIdentifier

Methods inherited from class org.commonreality.participant.impl.AbstractParticipant

addClientService, addServerService, getAgentObjectManager, getClock, getEfferentCommandManager, getIdentifier, getSensorObjectManager, isConnected, isInitialized, isStarted, isSuspended, reset, resume, send, suspend, waitForConnection, waitForInitialization, waitForResumption, waitForStart, waitForStop, waitForSuspension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.commonreality.participant.IParticipant

getAgentObjectManager, getClock, getEfferentCommandManager, getSensorObjectManager, isConnected, isInitialized, isStarted, isSuspended, reset, resume, send, suspend, waitForConnection, waitForResumption, waitForStart, waitForStop, waitForSuspension

Methods inherited from interface org.commonreality.identifier.IIdentifiable

getIdentifier

Field Detail

DATA_URL

public static final java.lang.String DATA_URL

See Also:

Constant Field Values

Constructor Detail

XMLSensor

public XMLSensor()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class AbstractParticipant

See Also:

AbstractParticipant.getName()

hasPendingTimeFrames

public boolean hasPendingTimeFrames()

queueNextFrame

public void queueNextFrame()

start

public void start()
           throws java.lang.Exception

Description copied from class: AbstractParticipant

called to actually start this participant

Specified by:

start in interface IParticipant

Overrides:

start in class AbstractParticipant

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Description copied from class: AbstractParticipant

called when this participant needs to stop

Specified by:

stop in interface IParticipant

Overrides:

stop in class AbstractParticipant

Throws:

java.lang.Exception

shutdown

public void shutdown()
              throws java.lang.Exception

Specified by:

shutdown in interface IParticipant

Overrides:

shutdown in class AbstractParticipant

Throws:

java.lang.Exception

configure

public void configure(java.util.Map<java.lang.String,java.lang.String> options)
               throws java.lang.Exception

Specified by:

configure in interface IParticipant

Overrides:

configure in class AbstractParticipant

Throws:

java.lang.Exception

queueFrame

public void queueFrame(org.w3c.dom.Element element)

executeFrameNow

public void executeFrameNow(org.w3c.dom.Element element)

will process the frame data immediately in the current thread. this should be used with caution as no checks are performed to ensure that the frame doesnt contain time relative information. Nor does it take into account any data that is pending delivery through the normal element frame queue

Parameters:

element -

initialize

public void initialize()
                throws java.lang.Exception

Description copied from class: AbstractParticipant

called in response to a command from Reality to get everything ready to run.

Specified by:

initialize in interface IParticipant

Overrides:

initialize in class AbstractParticipant

Throws:

java.lang.Exception