gov.sns.xal.model.gen
Interface IGenerationRule

public interface IGenerationRule

Interface to be exposed by classes implementing lattice element generation rules. Such classes should take a set of AcceleratorNode objects (including a single element) and return an ordered list of Element objects modeling the node set [set the function getElements()].

Method Summary

java.util.List	getElementList(java.util.Set setNodeCombin)
java.util.Set	getNodeSet() Returns a set of AcceleratorNode type string identifiers (order is not important).

Method Detail

getNodeSet

public java.util.Set getNodeSet()

Returns a set of AcceleratorNode type string identifiers (order is not important). The class implementing this interface is able to generate an order list of Element objects that model this node combination.

Returns:

set (unordered) of AcceleratorNode objects that generation rule handles

getElementList

public java.util.List getElementList(java.util.Set setNodeCombin)
                              throws GenerationException

GenerationException