mil.navy.nps.relate
Interface SensedEnvironment

All Known Implementing Classes:
CTFSensedEnvironment

public interface SensedEnvironment

This interface implements the RELATE SensedEnvironment.

A SensedEnvironment is a complex data structure unique to the simulation and defined by the developer. It must contain appropriate data members to store all aspects of the perceived environment. This interface requires the developer to implement methods to get the SensedEnvironment object, as well as a vector of the sensed agents that is used by the RelationshipManager.

Since:
JDK1.3
Version:
1.0, 17 Aug 00
Author:
Michael R. Dickson, Kimberly A. Roddy

Method Summary
 java.util.Vector getSensedAgents()
          Vector containing all sensed agents.
 SensedEnvironment getSensedEnvironment()
          Returns an Object that contains all required elements of the SensedEnvironment.
 

Method Detail

getSensedEnvironment

public SensedEnvironment getSensedEnvironment()
Returns an Object that contains all required elements of the SensedEnvironment. This method puts all of the various elements of the PerceivedEnvironment into an appropriate Object using getter-methods.

Returns:
A SensedEnvironment object.

getSensedAgents

public java.util.Vector getSensedAgents()
Vector containing all sensed agents. This is used by the relationshipManager in checking for new or formed relationships.

Returns:
A vector containing all currently sensed agents.