Package xal.smf.impl

Class GenericNode

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.GenericNode

All Implemented Interfaces:

Comparable, ElementType, DataListener

public class GenericNode
extends AcceleratorNode

GenericNode represents a node whose properties are defined by the data input. Unlike other nodes, there are no predefined methods associated with the channels. Instead, GenericNode is used to load nodes from data on the fly (for example from an XML file) so they can be manipulated in the accelerator object graph. One can use the "getHandles()" and "getChannel()" methods of AcceleratorNode to interact in a meaningful way with the generic nodes.

Author:

tap

Field Summary

Fields

Modifier and Type	Field	Description
protected String	strType

Fields inherited from class xal.smf.AcceleratorNode

bolIsSoft, bolStatus, bolValid, bucAlign, bucAper, bucTwiss, channelSuite, dblLen, dblPos, dblS, mapAttrs, objAccel, seqParent, strEId, strId, strPId

Constructor Summary

Constructors

Constructor	Description
GenericNode(String strType, String strId)	Constructor using default channel factory.
GenericNode(String strType, String strId, ChannelFactory channelFactory)	Primary Constructor.

Method Summary

Modifier and Type	Method	Description
String	getType()	Overriden to provide type signature
boolean	isKindOf(String compType)	Determine if this node is of the specified type.
static GenericNode	newNode(String strType, String strId)	Deprecated.

Methods inherited from class xal.smf.AcceleratorNode

addBucket, batchConnectAllHandles, batchConnectAllHandlesAndWait, channelSuite, clear, compareTo, dataLabel, findChannel, getAccelerator, getAccessibleProperties, getAccessibleProperties, getAlign, getAllChannels, getAndConnectChannel, getAndConnectChannelSetAndReadback, getAper, getBucket, getBuckets, getChannel, getDefaultHandles, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getProperties, getReadbackHandles, getRollAngle, getSDisplay, getSetHandle, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isChannelSettable, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setDesignPropertyValue, setLength, setLivePropertyValue, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setValueAndVerify, setXOffset, setYawAngle, setYOffset, setZOffset, toString, update, write, writeAttributes, writeStatus

Methods inherited from class java.lang.Object

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

Field Details

strType

protected String strType

Constructor Details

GenericNode

public GenericNode(String strType,
 String strId,
 ChannelFactory channelFactory)

Primary Constructor.

Parameters:

strType - type of this node (since it is Generic and there is no default type)

strId - ID for this node

channelFactory - factory from which to generate channels

GenericNode

public GenericNode(String strType,
 String strId)

Constructor using default channel factory.

Parameters:

strType - type of this node (since it is Generic and there is no default type)

strId - ID for this node

Method Details

getType

public String getType()

Overriden to provide type signature

Specified by:

getType in class AcceleratorNode

newNode

@Deprecated
public static GenericNode newNode(String strType,
 String strId)

Deprecated.

Instantiate a new GenericNode

isKindOf

public boolean isKindOf(String compType)

Determine if this node is of the specified type. Override the inherited method since the types of generic nodes are not associated with the class unlike typical nodes.

Specified by:

isKindOf in interface ElementType

Overrides:

isKindOf in class AcceleratorNode

Parameters:

compType - The type to compare against.

Returns:

true if the node is a match and false otherwise.