xal.smf.proxy

Class PrimaryPropertyAccessor

java.lang.Object

xal.smf.proxy.PrimaryPropertyAccessor

public class PrimaryPropertyAccessor
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PrimaryPropertyAccessor() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addInput(ModelInput anInput)
PropertyAccessor	getAccessorFor(AcceleratorNode node) get the accessor for the specified node
ModelInput	getInput(AcceleratorNode aNode, java.lang.String propName) Returns the ModelInput for the specified node's property, or null if there is none.
java.util.Map<java.lang.String,java.lang.Double>	getWhatifValueMapFromCache(java.lang.Object objNode) Use the cache rather than other sources for the value map and then apply the model inputs
boolean	hasAccessorFor(AcceleratorNode aNode) Returns true if there is an accessor for the specified node type, false otherwise.
java.util.List<java.lang.String>	propertyNamesFor(AcceleratorNode aNode) Returns a List of property names for the supplied node.
void	removeInput(AcceleratorNode aNode, java.lang.String property)
void	requestValuesForNodes(java.util.Collection<AcceleratorNode> nodes, java.lang.String syncMode) request values for the nodes and the specified sync mode
ModelInput	setModelInput(AcceleratorNode aNode, java.lang.String property, double val) Sets the specified node's property to the specified value.
java.util.Map<java.lang.String,java.lang.Double>	valueMapFor(java.lang.Object objNode) Returns a Map of property values for the supplied node.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaryPropertyAccessor

public PrimaryPropertyAccessor()

Constructor

Method Detail

requestValuesForNodes

public void requestValuesForNodes(java.util.Collection<AcceleratorNode> nodes,
                                  java.lang.String syncMode)

request values for the nodes and the specified sync mode

valueMapFor

public java.util.Map<java.lang.String,java.lang.Double> valueMapFor(java.lang.Object objNode)

Returns a Map of property values for the supplied node. The map's keys are the property names as defined by the node class' propertyNames method, values are the Double value for that property on aNode.

Parameters:

objNode - the AcclereatorNode whose properties to return

Returns:

a Map of node property values

Throws:

ProxyException - if the node's accessor encounters an error getting a property value

getWhatifValueMapFromCache

public java.util.Map<java.lang.String,java.lang.Double> getWhatifValueMapFromCache(java.lang.Object objNode)

Use the cache rather than other sources for the value map and then apply the model inputs

propertyNamesFor

public java.util.List<java.lang.String> propertyNamesFor(AcceleratorNode aNode)

Returns a List of property names for the supplied node.

Parameters:

aNode - AcceleratorNode whose property names to return

Returns:

a List of property names for aNode

getAccessorFor

public PropertyAccessor getAccessorFor(AcceleratorNode node)

get the accessor for the specified node

hasAccessorFor

public boolean hasAccessorFor(AcceleratorNode aNode)

Returns true if there is an accessor for the specified node type, false otherwise.

Parameters:

aNode - AcceleratorNode whose type to find an accessor for

Returns:

true if there is an accessor for the supplied node, false otherwise

setModelInput

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

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

val - double value for property

getInput

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

Returns the ModelInput for the specified node's property, or null if there is none.

Parameters:

aNode - node whose property to get a ModelInput for

propName - name of property to get a ModelInput for

addInput

protected void addInput(ModelInput anInput)

removeInput

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