xal.smf

Class NodeChannelRef

java.lang.Object

xal.smf.NodeChannelRef

public class NodeChannelRef
extends java.lang.Object

Provides a reference to a channel within a node

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_handle the handle referencing the node's channel
protected AcceleratorNode	_node the node whose channel is being referenced

Constructor Summary

Constructors

Constructor and Description
NodeChannelRef(AcceleratorNode node, java.lang.String handle) Constructor

Method Summary

Modifier and Type	Method and Description
Channel	getChannel() Get the referenced channel.
java.lang.String	getHandle() Get the channel handle which references the channel for the node
static NodeChannelRef	getInstance(Accelerator accelerator, java.lang.String refString) attempt to parse the string for a node channel ref
AcceleratorNode	getNode() Get the node
java.lang.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 Detail

_node

protected final AcceleratorNode _node

the node whose channel is being referenced

_handle

protected final java.lang.String _handle

the handle referencing the node's channel

Constructor Detail

NodeChannelRef

public NodeChannelRef(AcceleratorNode node,
                      java.lang.String handle)

Constructor

Method Detail

getInstance

public static NodeChannelRef getInstance(Accelerator accelerator,
                                         java.lang.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 java.lang.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 java.lang.String toString()

Get a string representation of the node/channel reference

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the node/channel reference