Class AreaMember

java.lang.Object
   |
   +----AreaMember

public class AreaMember
extends Object
Class definition for a node that is allowed to be a member of an ATM area.

Version:
$Revision: 1.4 $, $Date: 2000/10/12 14:07:47 $
Author:
John Cavanaugh
See Also:
Area

Variable Index

 o loc
The relative location of the node within the area.
 o name
The name of the member node.

Constructor Index

 o AreaMember(String, PointDouble)
Constructs an AreaMember given the name of a node and its location.

Method Index

 o getLoc()
Get the location of the member node.
 o getName()
Get the name of the member node.
 o setLoc(double, double)
Set the member node's location.
 o setLoc(PointDouble)
Set the member node's location.
 o setName(String)
Set the member node's name.
 o toString()
Get a string describing the member.

Variables

 o name
 protected String name
The name of the member node.

 o loc
 protected PointDouble loc
The relative location of the node within the area. The location is specified as a fraction of the size of the area in both X and Y directions. For example, the upper left corner of the area is (0.0), and the center of the area is (0.5, 0.5). Loc can be null.

Constructors

 o AreaMember
 public AreaMember(String name,
                   PointDouble loc)
Constructs an AreaMember given the name of a node and its location.

Parameters:
name - The name of the member node.
loc - The location of the node.

Methods

 o getName
 public String getName()
Get the name of the member node.

Returns:
A string containing the node's name.
 o setName
 public void setName(String name)
Set the member node's name.

Parameters:
name - The name of the member node.
 o getLoc
 public PointDouble getLoc()
Get the location of the member node.

Returns:
A PointDouble containing the node's relative location within the area.
 o setLoc
 public void setLoc(double x,
                    double y)
Set the member node's location.

Parameters:
x - The relative X offset of the node.
y - The relative Y offset of the node.
 o setLoc
 public void setLoc(PointDouble loc)
Set the member node's location.

Parameters:
loc - The relative location of the node in the area.
 o toString
 public String toString()
Get a string describing the member.

Returns:
A string describing the area member object.
Overrides:
toString in class Object