xal.smf.impl

Class GenericNode

java.lang.Object

xal.smf.AcceleratorNode

xal.smf.impl.GenericNode

All Implemented Interfaces:

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_strType

Fields inherited from class xal.smf.AcceleratorNode

channelSuite, m_bolIsSoft, m_bolStatus, m_bolValid, m_bucAlign, m_bucAper, m_bucTwiss, m_dblLen, m_dblPos, m_dblS, m_mapAttrs, m_objAccel, m_seqParent, m_strEId, m_strId, m_strPId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericNode(java.lang.String strId) Creates a new instance of GenericNode.

Method Summary

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

Methods inherited from class xal.smf.AcceleratorNode

addBucket, channelSuite, clear, dataLabel, findChannel, getAccelerator, getAlign, getAndConnectChannel, getAper, getBucket, getBuckets, getChannel, getDesignPropertyValue, getEId, getHandles, getId, getLength, getLivePropertyChannels, getLivePropertyValue, getParent, getPId, getPitchAngle, getPosition, getPrimaryAncestor, getRollAngle, getSDisplay, getSoftType, getStatus, getTwiss, getValid, getXOffset, getYawAngle, getYOffset, getZOffset, hasBucket, hasParent, isMagnet, lazilyGetAndConnect, removeFromParent, setAccelerator, setAlign, setAper, setLength, setParent, setPitchAngle, setPosition, setRollAngle, setSDisplay, setStatus, setTwiss, setValid, setXOffset, setYawAngle, setYOffset, setZOffset, toString, update, write

Methods inherited from class java.lang.Object

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

Field Detail

m_strType

protected java.lang.String m_strType

Constructor Detail

GenericNode

protected GenericNode(java.lang.String strId)

Creates a new instance of GenericNode. Use the static "newNode()" method instead to instantiate a new GenericNode.

Method Detail

getType

public java.lang.String getType()

Overriden to provide type signature

Specified by:

getType in class AcceleratorNode

newNode

public static GenericNode newNode(java.lang.String strType,
                                  java.lang.String strId)

Instantiate a new GenericNode

isKindOf

public boolean isKindOf(java.lang.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.