[This is preliminary documentation and is subject to change.]
Creates Zone objects and provides access to the Zones created by an agent.
Agents exchange data with SIF zones via Zone and Topic objects, which can
be obtained with the ZoneFactory and TopicFactory classes. These factories
are available by calling the Agent.getZoneFactory and Agent.getTopicFactory
methods.
An Agent may have one Zone object per SIF zone to which it is connected.
Zone instances are returned by calling the getInstance method. When no
properties are specified for a zone, the agent's defaults are used. Default
properties are returned by the Agent.getProperties method. For a explanation
of the various properties that affect zones, refer to the AgentProperties
class description.
The getInstance method returns the same Zone object for a given zone
identifier for as long as it remains in the factory's cache. getAllZones
returns all zones in the cache. A Zone remains in the cache until its
disconnect method is called, at which point it is removed and can no longer
be used by agent. (Calling the Zone.connect method on a disconnected zone
throws an exception.) To reconnect to a zone after calling its disconnect
method, obtain a fresh Zone instance from the ZoneFactory.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IZoneFactory
Public Interface IZoneFactory
public interface class IZoneFactory
Members| All Members | Methods | ||||
| Icon | Member | Description |
|---|---|---|
 | GetAllZones()() | Gets all zones in the factory cache |
| GetInstance(String, String) | Gets a Zone instance with default properties |
| GetInstance(String, String, AgentProperties) | Gets a Zone instance with custom properties |
| GetZone(String) | Gets a Zone previously created by a call to getInstance |
| RemoveZone(IZone) | Remove a zone from the ZoneFactory
This method can only be called on a zone that is in the disconnected state.
|