Package xal.smf

Class NodeChannelRef

java.lang.Object

xal.smf.NodeChannelRef

public class NodeChannelRef
extends Object

Provides a reference to a channel within a node

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	handle	the handle referencing the node's channel
protected final AcceleratorNode	node	the node whose channel is being referenced

Constructor Summary

Constructors

Constructor	Description
NodeChannelRef(AcceleratorNode node, String handle)	Constructor

Method Summary

Modifier and Type	Method	Description
Channel	getChannel()	Get the referenced channel.
String	getHandle()	Get the channel handle which references the channel for the node
static NodeChannelRef	getInstance(Accelerator accelerator, String refString)	attempt to parse the string for a node channel ref
AcceleratorNode	getNode()	Get the node
String	toString()	Get a string representation of the node/channel reference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

node

protected final AcceleratorNode node

the node whose channel is being referenced

handle

protected final String handle

the handle referencing the node's channel

Constructor Details

NodeChannelRef

public NodeChannelRef(AcceleratorNode node,
 String handle)

Constructor

Method Details

getInstance

public static NodeChannelRef getInstance(Accelerator accelerator,
 String refString)

attempt to parse the string for a node channel ref

Parameters:

accelerator - the accelerator for which to search for the node

refString - the string to parse for the node and handle

Returns:

a node channel ref or null if no match can be found

getNode

public AcceleratorNode getNode()

Get the node

Returns:

the node

getHandle

public String getHandle()

Get the channel handle which references the channel for the node

Returns:

the handle

getChannel

public Channel getChannel()

Get the referenced channel.

Returns:

the node's channel corresponding to the handle

toString

public String toString()

Get a string representation of the node/channel reference

Overrides:

toString in class Object

Returns:

a string representation of the node/channel reference