public final class NetChannelLocation extends NetLocation
This class is a data structure representing the location of a NetChannelInput in a network. The NetChannelLocation consists of the NodeID of the Node on which the NetChannelInput resides, and its Virtual Channel Number, which is the number uniquely identifying the NetChannelInput on said Node.
To acquire the NetChannelLocation of a NetBarrier, use the getLocation method:
NetChannelLocation location = (NetChannelLocation)chan.getLocation();
The location returned depends on whether the channel is a NetChannelInput or a NetChannelOutput end. An input end will return its own location. An output end will return the location of the input end it is connected to. This is because we consider a networked channel to be a single, virtual construct, with only one location. That location is where the input end is located.
Constructor and description |
---|
NetChannelLocation
(NodeID aNodeID, int aVCN) Creates a new NetChannelLocation |
Type | Name and description |
---|---|
NodeAddress |
getNodeAddress() Gets the NodeAddress part of the location |
NodeID |
getNodeID() Gets the NodeID part of the location |
int |
getVCN() Gets the vcn part of the location |
static NetChannelLocation |
parse(String str) Converts the string form of a NetChannelLocation back into its object form |
String |
toString() Converts the NetChannelLocation object into a string representation of the form ncl://[NodeID]/[VCN] |
Methods inherited from class | Name |
---|---|
class NetLocation |
getNodeAddress, getNodeID |
Creates a new NetChannelLocation
aNodeID
- The NodeID part of the locationaVCN
- The vcn part of the locationGets the NodeAddress part of the location
Gets the NodeID part of the location
Gets the vcn part of the location
Converts the string form of a NetChannelLocation back into its object form
str
- The string representation of a NetChannelLocationConverts the NetChannelLocation object into a string representation of the form ncl://[NodeID]/[VCN]
JCSP for Java 1.8 generated 14-10-2016 by Jon Kerridge, Edinburgh Napier University - j dot kerridge at napier dot ac dot uk