xal.sim.sync

Class SynchronizationManager

java.lang.Object

xal.sim.sync.SynchronizationManager

public class SynchronizationManager
extends java.lang.Object

Manages synchronization mappings between accelerator node proxies and lattice elements.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SYNC_MODE

Constructor Summary

Constructors

Constructor and Description
SynchronizationManager()

Method Summary

Modifier and Type	Method and Description
java.util.List<IElement>	allElementsMappedTo(AcceleratorNode aNode)
boolean	checkSynchronization(AcceleratorNode aNode, java.util.Map<java.lang.String,java.lang.Double> values)
protected void	debugPrint()
ModelInput	getModelInput(AcceleratorNode aNode, java.lang.String propName) Returns the ModelInput for the specified node's property.
java.lang.String	getSynchronizationMode() Get the synchronization mode
java.util.Map<java.lang.String,java.lang.Double>	propertiesForNode(AcceleratorNode aNode)
void	removeModelInput(AcceleratorNode aNode, java.lang.String property)
void	resync()
static void	resync(IElement anElem, java.util.Map<java.lang.String,java.lang.Double> valueMap) Synchronizes anElem to the property values contained in valueMap.
void	resyncFromCache() use the cached values modified by the model inputs and resync the model
ModelInput	setModelInput(AcceleratorNode aNode, java.lang.String property, double value) Sets the specified node's property to the specified value.
void	setSynchronizationMode(java.lang.String newMode) Set the synchronization mode
void	synchronize(IComposite comp, AcceleratorNode node) Creates a synchronization association between the specified composite modeling element and accelerator hardware node.
void	synchronize(IElement anElem, AcceleratorNode aNode) Creates a synchronization between the specified element and accelerator node.
protected java.util.List<IElement>	synchronizedElementsMappedTo(AcceleratorNode aNode)
static java.util.List<java.lang.String>	syncModes()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SYNC_MODE

public static final java.lang.String DEFAULT_SYNC_MODE

See Also:

Constant Field Values

Constructor Detail

SynchronizationManager

public SynchronizationManager()

Method Detail

syncModes

public static java.util.List<java.lang.String> syncModes()

setSynchronizationMode

public void setSynchronizationMode(java.lang.String newMode)

Set the synchronization mode

getSynchronizationMode

public java.lang.String getSynchronizationMode()

Get the synchronization mode

resync

public void resync()
            throws SynchronizationException

Throws:

SynchronizationException

resyncFromCache

public void resyncFromCache()
                     throws SynchronizationException

use the cached values modified by the model inputs and resync the model

Throws:

SynchronizationException

resync

public static void resync(IElement anElem,
                          java.util.Map<java.lang.String,java.lang.Double> valueMap)
                   throws SynchronizationException

Synchronizes anElem to the property values contained in valueMap.

Parameters:

anElem - element to synchronize

valueMap - a Map whose keys are property names and values are String property values

Throws:

SynchronizationException

synchronize

public void synchronize(IElement anElem,
                        AcceleratorNode aNode)

Creates a synchronization between the specified element and accelerator node. Request is ignored if there is no synchronizer for the specified element type. Request is also ignored if there is no accessor for the specified node type, because the system doesn't know how to access data from that type of node.

Parameters:

anElem - the lattice element to create synchronization for

aNode - the accelerator node to synchronize the element with

synchronize

public void synchronize(IComposite comp,
                        AcceleratorNode node)

Creates a synchronization association between the specified composite modeling element and accelerator hardware node. A synchronization association is created for each modeling element in the composite element. Thus, the method is implemented by iterating over the composite elements of the argument and calling the method synchronize(IElement,AcceleratorNode).

NOTE:

Within the composite, a synchronization associate request is ignored if there is no synchronizer for the specified sub-element type. Request is also ignored if there is no accessor for the specified hardware node type, because the system does not know how to access data from the hardware object.

Parameters:

comp - composite modeling element requiring synchronization

node - hardware node providing synchronization

See Also:

synchronize(IElement, AcceleratorNode)

propertiesForNode

public java.util.Map<java.lang.String,java.lang.Double> propertiesForNode(AcceleratorNode aNode)

allElementsMappedTo

public java.util.List<IElement> allElementsMappedTo(AcceleratorNode aNode)

synchronizedElementsMappedTo

protected java.util.List<IElement> synchronizedElementsMappedTo(AcceleratorNode aNode)

setModelInput

public ModelInput setModelInput(AcceleratorNode aNode,
                                java.lang.String property,
                                double value)

Sets the specified node's property to the specified value. Replaces the existing value if there is one.

Parameters:

aNode - node whose property to set

property - name of property to set

value - double value for property

getModelInput

public ModelInput getModelInput(AcceleratorNode aNode,
                                java.lang.String propName)

Returns the ModelInput for the specified node's property.

Parameters:

aNode - node whose property to get a ModelInput for

propName - name of property to get a ModelInput for

removeModelInput

public void removeModelInput(AcceleratorNode aNode,
                             java.lang.String property)

debugPrint

protected void debugPrint()

checkSynchronization

public boolean checkSynchronization(AcceleratorNode aNode,
                                    java.util.Map<java.lang.String,java.lang.Double> values)
                             throws SynchronizationException

Throws:

SynchronizationException