Package jmri.jmrit.logixng.implementation

Class DefaultFemaleAnalogActionSocket

java.lang.Object

jmri.jmrit.logixng.implementation.AbstractFemaleSocket

jmri.jmrit.logixng.implementation.DefaultFemaleAnalogActionSocket

All Implemented Interfaces:

PropertyChangeProvider, AnalogAction, Base, FemaleAnalogActionSocket, FemaleSocket

public final class DefaultFemaleAnalogActionSocket
extends AbstractFemaleSocket
implements FemaleAnalogActionSocket

Default implementation of the Female Analog Action socket

Nested Class Summary

Nested classes/interfaces inherited from interface jmri.jmrit.logixng.Base

Base.PrintTreeSettings, Base.RunnableWithBase, Base.RunnableWithBaseThrowException

Field Summary

Fields inherited from class jmri.jmrit.logixng.implementation.AbstractFemaleSocket

_enableListeners, _listener

Fields inherited from interface jmri.jmrit.logixng.Base

PRINT_LINE_NUMBERS_FORMAT, PROPERTY_CHILD_COUNT, PROPERTY_CHILD_REORDER, PROPERTY_LAST_RESULT_CHANGED, PROPERTY_SOCKET_CONNECTED, PROPERTY_SOCKET_DISCONNECTED, SEPARATOR, SOCKET_CONNECTED, SOCKET_DISCONNECTED

Constructor Summary

Constructors

Constructor	Description
DefaultFemaleAnalogActionSocket(Base parent, FemaleSocketListener listener, String name)

Method Summary

Modifier and Type	Method	Description
void	disposeMe()
Map<Category,List<Class<? extends Base>>>	getConnectableClasses()	Get a set of classes that are compatible with this female socket.
String	getLongDescription(Locale locale)	Get a long description of this item.
String	getShortDescription(Locale locale)	Get a short description of this item.
boolean	isCompatible(MaleSocket socket)	Is a particular male socket compatible with this female socket?
void	setValue(double value)	Set an analog value.

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractFemaleSocket

addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, addPropertyChangeListener, connect, deepCopyChildren, disconnect, dispose, forEntireTree, forEntireTreeWithException, getCategory, getChild, getChildCount, getComment, getConditionalNG, getConnectedSocket, getDeepCopy, getEnableListeners, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getName, getNumPropertyChangeListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeListenersByReference, getRoot, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isConnected, printTree, printTree, printTree, printTreeRow, registerListeners, registerListenersForThisClass, removePropertyChangeListener, removePropertyChangeListener, setComment, setEnableListeners, setName, setParent, setParentForAllChildren, setUserName, unregisterListeners, unregisterListenersForThisClass, updateListenerRef, validateName, vetoableChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrit.logixng.Base

addPropertyChangeListener, addPropertyChangeListener, deepCopyChildren, dispose, doSocketOperation, existsInTree, forEntireTree, forEntireTreeWithException, getCategory, getChild, getChildCount, getComment, getConditionalNG, getDeepCopy, getListenerRef, getListenerRefs, getListenerRefsIncludingChildren, getLogixNG, getLongDescription, getModule, getNumPropertyChangeListeners, getParent, getPropertyChangeListenersByReference, getRoot, getShortDescription, getSystemName, getUsageDetail, getUsageTree, getUserName, hasChild, isActive, isEnabled, isSocketOperationAllowed, printTree, printTree, printTree, printTree, printTree, registerListeners, setComment, setParent, setParentForAllChildren, setUserName, unregisterListeners, updateListenerRef, vetoableChange

Methods inherited from interface jmri.jmrit.logixng.FemaleSocket

canDisconnect, connect, disconnect, doSocketOperation, getConnectedSocket, getEnableListeners, getName, isAncestor, isConnected, isSocketOperationAllowed, setEnableListeners, setName, setName, setup, validateName, validateName

Methods inherited from interface jmri.beans.PropertyChangeProvider

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Constructor Details

DefaultFemaleAnalogActionSocket

public DefaultFemaleAnalogActionSocket(Base parent,
 FemaleSocketListener listener,
 String name)

Method Details

isCompatible

public boolean isCompatible(MaleSocket socket)

Is a particular male socket compatible with this female socket?

Specified by:

isCompatible in interface FemaleSocket

Parameters:

socket - the male socket

Returns:

true if the male socket can be connected to this female socket

getConnectableClasses

public Map<Category,List<Class<? extends Base>>> getConnectableClasses()

Get a set of classes that are compatible with this female socket.

Specified by:

getConnectableClasses in interface FemaleSocket

Returns:

a set of entries with category and class

setValue

public void setValue(double value)
              throws JmriException

Set an analog value.

Specified by:

setValue in interface AnalogAction

Parameters:

value - the value. The male socket that holds this action ensures that this value is not Double.NaN or an infinite value.

Throws:

JmriException - when an exception occurs

getShortDescription

public String getShortDescription(Locale locale)

Get a short description of this item.

Specified by:

getShortDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a short description

getLongDescription

public String getLongDescription(Locale locale)

Get a long description of this item.

Specified by:

getLongDescription in interface Base

Parameters:

locale - The locale to be used

Returns:

a long description

disposeMe

public void disposeMe()

Specified by:

disposeMe in class AbstractFemaleSocket