gov.sns.xal.model.gen.ptree
Class ProxyTree

java.lang.Object
  |
  +--gov.sns.xal.model.gen.ptree.ProxyNode
        |
        +--gov.sns.xal.model.gen.ptree.ProxyTree

public class ProxyTree

extends ProxyNode

This class embodies a root node in a proxy tree, or the root node of a sub-tree. It maintains a reference to an AcceleratorSeq object from the SMF hierarchy that it represents and knows how to build a proxy tree from such an hardware object. This class is also the entry point for any proxy-tree visitor. That is, proxy trees support the Visitor design pattern. Here, a visitor class is identified by one which implements the IProxyVisitor interface.

Field Summary

static double

s_dblTolerance

Constructor Summary

ProxyTree(AcceleratorSeq smfSeq)
Build a ProxyTree object representing the provided AcceleratorSeq object.

Method Summary

void	disseminateVisitor(IProxyVisitor iVisitor) Distributes the visitor object (argument implementing the IProxyVisitor interface) to all nodes of the tree.
static double	getDriftTolerance() Get the smallest possible drift space length
AcceleratorSeq	getHardwareRef() Return the hardware reference represented by this proxy element.

Methods inherited from class gov.sns.xal.model.gen.ptree.ProxyNode

childIterator, getChildCount, getInterval, leafVisitor

Methods inherited from class java.lang.Object

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

Field Detail

s_dblTolerance

public static final double s_dblTolerance

See Also:

Constant Field Values

Constructor Detail

ProxyTree

public ProxyTree(AcceleratorSeq smfSeq)
          throws GenerationException

Build a ProxyTree object representing the provided AcceleratorSeq object.

Parameters:

smfSeq - initialization object

Method Detail

getDriftTolerance

public static double getDriftTolerance()

Get the smallest possible drift space length

Returns:

smallest length of a drift to consider

getHardwareRef

public AcceleratorSeq getHardwareRef()

Return the hardware reference represented by this proxy element.

Returns:

hardware object that this proxy node represents

disseminateVisitor

public void disseminateVisitor(IProxyVisitor iVisitor)
                        throws GenerationException

Description copied from class: ProxyNode

Distributes the visitor object (argument implementing the IProxyVisitor interface) to all nodes of the tree. The processVisitor() method is called on on the current node first, then consecutively on each child node.

Overrides:

disseminateVisitor in class ProxyNode

Parameters:

iVisitor -

GenerationException

See Also:

ProxyNode.disseminateVisitor(gov.sns.xal.model.gen.ptree.IProxyVisitor)