DISEntityManager (X3DJSAIL, X3D Java Scene Access Interface Library)

All Superinterfaces:

X3DChildNode, X3DNode

All Known Implementing Classes:

DISEntityManagerObject
```
public interface DISEntityManager
extends X3DChildNode
```
Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DChildNode] DISEntityManager notifies a scene when new DIS ESPDU entities arrive or current entities leave. DISEntityManager may contain any number of DISEntityTypeMapping nodes that provide a best-match X3D model to incoming entity type values. For each new DIS entity, DISEntityManager thus produces a new EspduTransform node that contains a corresponding X3D model.
- Hint: DISEntityManager contains DISEntityTypeMapping nodes.
- Hint: DisEntityManager ESPDU packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
- Hint: Savage Developers Guide on DIS
  https://savage.nps.edu/Savage/developers.html#DIS
- Hint: X3D for Advanced Modeling (X3D4AM) slideset
  http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
- Warning: requires X3D profile='Full' or else include <component name='DIS' level='2'/>
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

SAI Java Specification: TODO, X3D Abstract Specification: DISEntityManager, X3D Tooltips: DISEntityManager, X3D Scene Authoring Hints

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addMapping(X3DNode[] newValue)` Add array of child mapping nodes to array of existing nodes (if any).
`java.lang.String`	`getAddress()` Provide String value from inputOutput SFString field named address.
`int`	`getApplicationID()` Provide int value from inputOutput SFInt32 field named applicationID.
`X3DNode[]`	`getMapping()` Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field mapping.
`X3DMetadataObject`	`getMetadata()` Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
`int`	`getPort()` Provide int value from inputOutput SFInt32 field named port.
`int`	`getSiteID()` Provide int value from inputOutput SFInt32 field named siteID.
`DISEntityManager`	`setAddress(java.lang.String newValue)` Assign String value to inputOutput SFString field named address.
`DISEntityManager`	`setApplicationID(int newValue)` Assign int value to inputOutput SFInt32 field named applicationID.
`DISEntityManager`	`setCssClass(java.lang.String newValue)` Assign String value to inputOutput SFString field named class.
`DISEntityManager`	`setDEF(java.lang.String newValue)` Assign String value to inputOutput SFString field named DEF.
`void`	`setMapping(X3DNode newValue)` Set single child mapping node, replacing prior array of existing nodes (if any).
`DISEntityManager`	`setMapping(X3DNode[] newValue)` Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field mapping.
`DISEntityManager`	`setMetadata(X3DMetadataObject newValue)` Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
`DISEntityManager`	`setPort(int newValue)` Assign int value to inputOutput SFInt32 field named port.
`DISEntityManager`	`setSiteID(int newValue)` Assign int value to inputOutput SFInt32 field named siteID.
`DISEntityManager`	`setUSE(java.lang.String newValue)` Assign String value to inputOutput SFString field named USE.

- Method Detail
  - getAddress
```
java.lang.String getAddress()
```
    Provide String value from inputOutput SFString field named address.
    
    Tooltip: Multicast network address, or else "localhost" example: 224.2.181.145. *
    
    Returns:
    
    value of address field
  - setAddress
```
DISEntityManager setAddress(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named address.
    
    Tooltip: Multicast network address, or else "localhost" example: 224.2.181.145.
    
    Parameters:
    
    newValue - is new value for the address field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getApplicationID
```
int getApplicationID()
```
    Provide int value from inputOutput SFInt32 field named applicationID.
    
    Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
    
    Returns:
    
    value of applicationID field
  - setApplicationID
```
DISEntityManager setApplicationID(int newValue)
```
    Assign int value to inputOutput SFInt32 field named applicationID.
    
    Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID.
    
    Parameters:
    
    newValue - is new value for the applicationID field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getMapping
```
X3DNode[] getMapping()
```
    Provide array of X3DNode results (using an array consisting of properly typed nodes or ProtoInstanceObjects) from inputOutput MFNode field mapping.
    
    Tooltip: [DISEntityTypeMapping] mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform specified in the addedEntities field.
    - Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence.
    Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
    Returns:
    
    value of mapping field
    
    See Also:
    
    DISEntityTypeMappingObject
  - setMapping
```
DISEntityManager setMapping(X3DNode[] newValue)
```
    Assign X3DNode array (using an array consisting of properly typed nodes or ProtoInstanceObjects) to inputOutput MFNode field mapping.
    
    Tooltip: [DISEntityTypeMapping] mapping field provides a mechanism for automatically creating an X3D model when a new entity arrives over the network. If a new entity matches one of the nodes, an instance of the provided URL is created and added as a child to the EspduTransform specified in the addedEntities field. Hint: multiple DISEntityTypeMapping nodes can be provided in mapping field, best match takes precedence.
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
    
    Parameters:
    
    newValue - is new value for the mapping field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - addMapping
```
void addMapping(X3DNode[] newValue)
```
    Add array of child mapping nodes to array of existing nodes (if any).
    
    Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to DISEntityTypeMapping.
    
    Parameters:
    
    newValue - is new value array to be appended the mapping field.
  - setMapping
```
void setMapping(X3DNode newValue)
```
    Set single child mapping node, replacing prior array of existing nodes (if any).
    
    Parameters:
    
    newValue - is new node for the mapping field
  - getMetadata
```
X3DMetadataObject getMetadata()
```
    Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    
    Specified by:
    
    getMetadata in interface X3DChildNode
    
    Specified by:
    
    getMetadata in interface X3DNode
    
    Returns:
    
    value of metadata field
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - setMetadata
```
DISEntityManager setMetadata(X3DMetadataObject newValue)
```
    Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    
    Specified by:
    
    setMetadata in interface X3DChildNode
    
    Specified by:
    
    setMetadata in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the metadata field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    
    See Also:
    
    X3D Scene Authoring Hints: Metadata Nodes
  - getPort
```
int getPort()
```
    Provide int value from inputOutput SFInt32 field named port.
    
    Tooltip: Multicast network port, for example: 3000. *
    
    Returns:
    
    value of port field
  - setPort
```
DISEntityManager setPort(int newValue)
```
    Assign int value to inputOutput SFInt32 field named port.
    
    Tooltip: Multicast network port, for example: 3000.
    
    Parameters:
    
    newValue - is new value for the port field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - getSiteID
```
int getSiteID()
```
    Provide int value from inputOutput SFInt32 field named siteID.
    
    Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
    
    Returns:
    
    value of siteID field
  - setSiteID
```
DISEntityManager setSiteID(int newValue)
```
    Assign int value to inputOutput SFInt32 field named siteID.
    
    Tooltip: Simulation/exercise siteID of the participating LAN or organization.
    
    Parameters:
    
    newValue - is new value for the siteID field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setDEF
```
DISEntityManager setDEF(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named DEF.
    
    Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions
    
    Note that setting the DEF value clears the USE value.
    
    Specified by:
    
    setDEF in interface X3DChildNode
    
    Specified by:
    
    setDEF in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the DEF field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setUSE
```
DISEntityManager setUSE(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named USE.
    
    Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
    
    Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.
    
    Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
    
    Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
    
    Specified by:
    
    setUSE in interface X3DChildNode
    
    Specified by:
    
    setUSE in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the USE field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  - setCssClass
```
DISEntityManager setCssClass(java.lang.String newValue)
```
    Assign String value to inputOutput SFString field named class.
    
    Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
    
    Specified by:
    
    setCssClass in interface X3DChildNode
    
    Specified by:
    
    setCssClass in interface X3DNode
    
    Parameters:
    
    newValue - is new value for the class field.
    
    Returns:
    
    DISEntityManager - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface DISEntityManager

Method Summary

Method Detail

getAddress

setAddress

getApplicationID

setApplicationID

getMapping

setMapping

addMapping

setMapping

getMetadata

setMetadata

getPort

setPort

getSiteID

setSiteID

setDEF

setUSE

setCssClass