org.vrjuggler.vrjconfig.commoneditors.devicegraph
Class RelativeDeviceInfo

java.lang.Object
  org.vrjuggler.vrjconfig.commoneditors.devicegraph.ConfigElementHolder
      org.vrjuggler.vrjconfig.commoneditors.devicegraph.BaseDeviceInfo
          org.vrjuggler.vrjconfig.commoneditors.devicegraph.DeviceInfo
              org.vrjuggler.vrjconfig.commoneditors.devicegraph.RelativeDeviceInfo

All Implemented Interfaces:

EventListener, ConfigElementListener

public class RelativeDeviceInfo
extends DeviceInfo

A custom device informational object for devices that are configured relative to one or more proxies.

Constructor Summary

RelativeDeviceInfo(ConfigElement devElt, ConfigContext ctx, Collection unitTypes, List pointerPropDefs)
This version of the constructor should be used when the config element has a fixed number of input sources (units) and supports multiipe input source types.

RelativeDeviceInfo(ConfigElement devElt, ConfigContext ctx, List pointerPropDefs)
Creates a new RelativeDeviceInfo object for a device that has exactly one input source (unit) at all times.

RelativeDeviceInfo(ConfigElement devElt, ConfigContext ctx, Map unitTypeMap, DeviceUnitPropertyHandler handler, List pointerPropDefs)
This version of the constructor should be used when the config element has a variable number of input sources (units) and supports multiipe input source types.

RelativeDeviceInfo(ConfigElement devElt, ConfigContext ctx, Map unitTypeMap, List pointerPropDefs)
This version of the constructor should be used when the config element has a variable number of input sources (units) and supports multiipe input source types.

RelativeDeviceInfo(ConfigElement devElt, ConfigContext ctx, String unitPropertyName, List pointerPropDefs)
Creates a new DeviceInfo object and looks up the property definition for the named property if a name is provided.

Method Summary

boolean

acceptsSource(GraphModel model, Object edge, Object port) Verifies that the given port can be a source of the given edge within the given model.

Methods inherited from class org.vrjuggler.vrjconfig.commoneditors.devicegraph.DeviceInfo

addDeviceUnitListener, addUnit, getUnitTypes, hasVariableUnitCount, nameChanged, propertyValueAdded, propertyValueChanged, propertyValueOrderChanged, propertyValueRemoved, removeDeviceUnitListener, removeUnit, removeUnit

Methods inherited from class org.vrjuggler.vrjconfig.commoneditors.devicegraph.BaseDeviceInfo

acceptsTarget

Methods inherited from class org.vrjuggler.vrjconfig.commoneditors.devicegraph.ConfigElementHolder

getContext, getElement, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativeDeviceInfo

public RelativeDeviceInfo(ConfigElement devElt,
                          ConfigContext ctx,
                          List pointerPropDefs)

Creates a new RelativeDeviceInfo object for a device that has exactly one input source (unit) at all times. The default device unit handler delegate is created to manage the units.

Parameters:

devElt - the device config element

ctx - the config context that contains devElt

pointerPropDefs - the list of org.vrjuggler.jccl.config.PropertyDefinition objects providing the information about the proxy types to which this device may be configured

RelativeDeviceInfo

public RelativeDeviceInfo(ConfigElement devElt,
                          ConfigContext ctx,
                          String unitPropertyName,
                          List pointerPropDefs)

Creates a new DeviceInfo object and looks up the property definition for the named property if a name is provided. The value of unitPropertyName may be null. If it is non-null, then it must be the name of a property in devElt's config definition. This version of the constructor should be used when the config element has a proeprty with a variable number of values that indicate how many input sources (units) are available in the device. The default device unit handler delegate is created to manage the units.

Parameters:

devElt - the device config element

ctx - the config context that contains devElt

unitPropertyName - the name of the property that represents the number of available input sources (units) the device has (may be null)

pointerPropDefs - the list of org.vrjuggler.jccl.config.PropertyDefinition objects providing the information about the proxy types to which this device may be configured

See Also:

DefaultUnitPropertyHandler

RelativeDeviceInfo

public RelativeDeviceInfo(ConfigElement devElt,
                          ConfigContext ctx,
                          Map unitTypeMap,
                          List pointerPropDefs)

This version of the constructor should be used when the config element has a variable number of input sources (units) and supports multiipe input source types. The default device unit handler delegate is created to manage the units.

Parameters:

devElt - the device config element

ctx - the config context that contains devElt

unitTypeMap - a mapping from unit types (as defined in UnitConstants to some value that the default device unit property handler knows how to manage

pointerPropDefs - the list of org.vrjuggler.jccl.config.PropertyDefinition objects providing the information about the proxy types to which this device may be configured

See Also:

UnitConstants, DefaultUnitPropertyHandler

RelativeDeviceInfo

public RelativeDeviceInfo(ConfigElement devElt,
                          ConfigContext ctx,
                          Map unitTypeMap,
                          DeviceUnitPropertyHandler handler,
                          List pointerPropDefs)

This version of the constructor should be used when the config element has a variable number of input sources (units) and supports multiipe input source types. The given unit handler delegate is stored to manage the device units.

Parameters:

devElt - the device config element

ctx - the config context that contains devElt

unitTypeMap - a mapping from unit types (as defined in UnitConstants to some value that the device unit property handler knows how to manage

handler - the delegate for managing the device unit properties

pointerPropDefs - the list of org.vrjuggler.jccl.config.PropertyDefinition objects providing the information about the proxy types to which this device may be configured

See Also:

UnitConstants

RelativeDeviceInfo

public RelativeDeviceInfo(ConfigElement devElt,
                          ConfigContext ctx,
                          Collection unitTypes,
                          List pointerPropDefs)

This version of the constructor should be used when the config element has a fixed number of input sources (units) and supports multiipe input source types.

Parameters:

devElt - the device config element

ctx - the config context that contains devElt

unitTypes - the list of unit types supported by this device

pointerPropDefs - the list of org.vrjuggler.jccl.config.PropertyDefinition objects providing the information about the proxy types to which this device may be configured

See Also:

UnitConstants

Method Detail

acceptsSource

public boolean acceptsSource(GraphModel model,
                             Object edge,
                             Object port)

Verifies that the given port can be a source of the given edge within the given model. This determination is made by testing to see if the config element held by the parent of the target port (which must have parent containing a ProxyInfo object) is of a type to which we are allowed to point.

Overrides:

acceptsSource in class BaseDeviceInfo