org.web3d.vrml.nodes
Interface VRMLDISNodeType

All Superinterfaces:

FrameStateListener, VRMLChildNodeType, VRMLNetworkInterfaceNodeType, VRMLNode, VRMLNodeType

All Known Subinterfaces:

VRMLDISManagerNodeType

public interface VRMLDISNodeType

extends VRMLNetworkInterfaceNodeType

Common interface for all DIS nodes.

Provides access to networking and indentification params.

Version:

$Revision: 1.6 $

Author:

Alan Hudson

Field Summary

Fields inherited from interface org.web3d.vrml.nodes.VRMLNetworkInterfaceNodeType

ROLE_INACTIVE, ROLE_MANAGER, ROLE_READER, ROLE_WRITER

Method Summary

java.lang.String	getAddress() Get the network address to listen to.
int	getAppID() Get the applicationID specified for this node.
java.lang.String[]	getAuthServer() Get the chat room auth server's.
int	getEntityID() Get the entityID specified for this node.
java.lang.String	getMucRoom() Get the chat room mucRoom.
java.lang.String	getMucServer() Get the chat room mucServer.
java.lang.String	getPassword() Get the chat room password.
int	getPort() Get the network port to listen to.
int	getSiteID() Get the siteID specified for this node.
ProtocolDataUnit	getState() Get the nodes current state.
ProtocolDataUnitType	getStateDX() Get the nodes current state.
java.lang.String	getUsername() Get the chat room username.
void	packetArrived(ProtocolDataUnit pdu) Tell the DIS node that a packet arrived.
void	setIsActive(boolean active) Set the isActive state for a DIS node.
boolean	valuesToWrite() Does the this node have new information to write.

Methods inherited from interface org.web3d.vrml.nodes.VRMLNetworkInterfaceNodeType

addNetworkRoleListener, getProtocol, getRole, removeNetworkRoleListener

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, getFieldValue, getMetadataObject, getRefCount, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Method Detail

getSiteID

public int getSiteID()

Get the siteID specified for this node.

Returns:

the siteID.

getAppID

public int getAppID()

Get the applicationID specified for this node.

Returns:

the applicationID.

getEntityID

public int getEntityID()

Get the entityID specified for this node.

Returns:

the entityID.

getAddress

public java.lang.String getAddress()

Get the network address to listen to.

Returns:

The address.

getPort

public int getPort()

Get the network port to listen to.

Returns:

The port.

getUsername

public java.lang.String getUsername()

Get the chat room username.

Returns:

The username. null if none provided

getPassword

public java.lang.String getPassword()

Get the chat room password.

Returns:

The password. null if none provided

getAuthServer

public java.lang.String[] getAuthServer()

Get the chat room auth server's.

Returns:

The auth servers. null if none provided

getMucServer

public java.lang.String getMucServer()

Get the chat room mucServer.

Returns:

The mucServer. null if none provided

getMucRoom

public java.lang.String getMucRoom()

Get the chat room mucRoom.

Returns:

The mucRoom. null if none provided

setIsActive

public void setIsActive(boolean active)

Set the isActive state for a DIS node.

Parameters:

active - Whether the node is active(traffic within 5 seconds).

packetArrived

public void packetArrived(ProtocolDataUnit pdu)

Tell the DIS node that a packet arrived. Used to update tiemstamp information and update local fields.

valuesToWrite

public boolean valuesToWrite()

Does the this node have new information to write. This only accounts for local values, not required DIS heartbeart rules.

Returns:

TRUE if values have changed.

getState

public ProtocolDataUnit getState()

Get the nodes current state. Assume that a single local scratch var can be reused each time.

Returns:

The DIS state.

getStateDX

public ProtocolDataUnitType getStateDX()

Get the nodes current state. Assume that a single local scratch var can be reused each time.

Returns:

The DIS state.