org.openlcb.implementations

Class BitProducerConsumer

java.lang.Object

org.openlcb.AbstractConnection

org.openlcb.MessageDecoder

org.openlcb.implementations.BitProducerConsumer

All Implemented Interfaces:

Connection

public class BitProducerConsumer
extends MessageDecoder

Maintains a bit represented by two event IDs: one off, one on.

Created by bracz on 1/6/16.

Nested Class Summary

Nested classes/interfaces inherited from interface org.openlcb.Connection

Connection.ConnectionListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FLAGS
static int	DEFAULT_TRUE
private EventID	eventOff
private EventID	eventOn
private int	flags
private OlcbInterface	iface
static int	IS_CONSUMER
static int	IS_PRODUCER
static int	LISTEN_EVENT_IDENTIFIED
static int	LISTEN_INVALID_STATE
static EventID	nullEvent
static int	QUERY_AT_STARTUP
static int	SEND_UNKNOWN_EVENT_IDENTIFIED
private VersionedValue<Boolean>	value
private VersionedValueListener<Boolean>	valueListener

Constructor Summary

Constructors

Constructor and Description
BitProducerConsumer(OlcbInterface iface, EventID eventOn, EventID eventOff)
BitProducerConsumer(OlcbInterface iface, EventID eventOn, EventID eventOff, boolean defaultValue)
BitProducerConsumer(OlcbInterface iface, EventID eventOn, EventID eventOff, int flags)

Method Summary

Modifier and Type	Method and Description
private EventState	getEventState(EventID event)
private EventState	getOffEventState()
private EventState	getOnEventState()
VersionedValue<Boolean>	getValue()
void	handleConsumerIdentified(ConsumerIdentifiedMessage msg, Connection sender) Handle "Consumer Identified" message
void	handleIdentifyConsumers(IdentifyConsumersMessage msg, Connection sender) Handle "Identify Consumers" message
void	handleIdentifyEventsAddressed(IdentifyEventsAddressedMessage msg, Connection sender) Handle "Identify Event" message
void	handleIdentifyEventsGlobal(IdentifyEventsGlobalMessage msg, Connection sender) Handle "Identify Event Global" message
void	handleIdentifyProducers(IdentifyProducersMessage msg, Connection sender) Handle "Identify Producers" message
void	handleProducerConsumerEventReport(ProducerConsumerEventReportMessage msg, Connection sender) Handle "Producer/Consumer Event Report" message
void	handleProducerIdentified(ProducerIdentifiedMessage msg, Connection sender) Handle "Producer Identified" message
boolean	isValueAtDefault()
void	release()
void	resetToDefault() Resets the producer/consumer to its default state.
private void	sendIdentifiedMessages(boolean queryState)
(package private) <T extends EventMessage> void	sendMessage(T msg) Sends out an event message
void	sendQuery() Sends out query messages to the bus.
private void	setValueFromNetwork(boolean isOn)
private boolean	shouldListenToIdentifiedMessages()

Methods inherited from class org.openlcb.MessageDecoder

defaultHandler, handleConsumerRangeIdentified, handleDatagram, handleDatagramAcknowledged, handleDatagramRejected, handleInitializationComplete, handleLearnEvent, handleOptionalIntRejected, handleProducerRangeIdentified, handleProtocolIdentificationReply, handleProtocolIdentificationRequest, handleSimpleNodeIdentInfoReply, handleSimpleNodeIdentInfoRequest, handleStreamDataComplete, handleStreamDataProceed, handleStreamDataSend, handleStreamInitiateReply, handleStreamInitiateRequest, handleTractionControlReply, handleTractionControlRequest, handleTractionProxyReply, handleTractionProxyRequest, handleUnknownMTI, handleVerifiedNodeIDNumber, handleVerifyNodeIDNumberAddressed, handleVerifyNodeIDNumberGlobal, put

Methods inherited from class org.openlcb.AbstractConnection

registerStartNotification

Methods inherited from class java.lang.Object

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

Field Detail

eventOn

private final EventID eventOn

eventOff

private final EventID eventOff

iface

private final OlcbInterface iface

value

private final VersionedValue<Boolean> value

valueListener

private final VersionedValueListener<Boolean> valueListener

flags

private final int flags

nullEvent

public static final EventID nullEvent

DEFAULT_TRUE

public static final int DEFAULT_TRUE

See Also:

Constant Field Values

IS_PRODUCER

public static final int IS_PRODUCER

See Also:

Constant Field Values

IS_CONSUMER

public static final int IS_CONSUMER

See Also:

Constant Field Values

QUERY_AT_STARTUP

public static final int QUERY_AT_STARTUP

See Also:

Constant Field Values

LISTEN_EVENT_IDENTIFIED

public static final int LISTEN_EVENT_IDENTIFIED

See Also:

Constant Field Values

SEND_UNKNOWN_EVENT_IDENTIFIED

public static final int SEND_UNKNOWN_EVENT_IDENTIFIED

See Also:

Constant Field Values

LISTEN_INVALID_STATE

public static final int LISTEN_INVALID_STATE

See Also:

Constant Field Values

DEFAULT_FLAGS

public static final int DEFAULT_FLAGS

See Also:

Constant Field Values

Constructor Detail

BitProducerConsumer

public BitProducerConsumer(OlcbInterface iface,
                           EventID eventOn,
                           EventID eventOff)

BitProducerConsumer

public BitProducerConsumer(OlcbInterface iface,
                           EventID eventOn,
                           EventID eventOff,
                           boolean defaultValue)

BitProducerConsumer

public BitProducerConsumer(OlcbInterface iface,
                           EventID eventOn,
                           EventID eventOff,
                           int flags)

Method Detail

getValue

public VersionedValue<Boolean> getValue()

resetToDefault

public void resetToDefault()

Resets the producer/consumer to its default state. This will not change the actual state (also not trigger listeners), but will start reporting unknown state to the network, and enables sending a new query message to the network using @link sendQuery(), assuming the flags are set up for that.

sendQuery

public void sendQuery()

Sends out query messages to the bus. Useful to be called after resetToDefault().

sendMessage

<T extends EventMessage> void sendMessage(T msg)

Sends out an event message

Type Parameters:

T - the message type to send.

Parameters:

msg - event message to send

isValueAtDefault

public boolean isValueAtDefault()

Returns:

true if we have not received any network state yet, thus the value is still at the default value passed in.

getOnEventState

private EventState getOnEventState()

getOffEventState

private EventState getOffEventState()

getEventState

private EventState getEventState(EventID event)

sendIdentifiedMessages

private void sendIdentifiedMessages(boolean queryState)

release

public void release()

handleIdentifyConsumers

public void handleIdentifyConsumers(IdentifyConsumersMessage msg,
                                    Connection sender)

Description copied from class: MessageDecoder

Handle "Identify Consumers" message

Overrides:

handleIdentifyConsumers in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

handleIdentifyProducers

public void handleIdentifyProducers(IdentifyProducersMessage msg,
                                    Connection sender)

Description copied from class: MessageDecoder

Handle "Identify Producers" message

Overrides:

handleIdentifyProducers in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

shouldListenToIdentifiedMessages

private boolean shouldListenToIdentifiedMessages()

Returns:

true if we are interested in a P/C identified message reporting layout state right now.

handleProducerIdentified

public void handleProducerIdentified(ProducerIdentifiedMessage msg,
                                     Connection sender)

Description copied from class: MessageDecoder

Handle "Producer Identified" message

Overrides:

handleProducerIdentified in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

handleConsumerIdentified

public void handleConsumerIdentified(ConsumerIdentifiedMessage msg,
                                     Connection sender)

Description copied from class: MessageDecoder

Handle "Consumer Identified" message

Overrides:

handleConsumerIdentified in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

handleProducerConsumerEventReport

public void handleProducerConsumerEventReport(ProducerConsumerEventReportMessage msg,
                                              Connection sender)

Description copied from class: MessageDecoder

Handle "Producer/Consumer Event Report" message

Overrides:

handleProducerConsumerEventReport in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

handleIdentifyEventsAddressed

public void handleIdentifyEventsAddressed(IdentifyEventsAddressedMessage msg,
                                          Connection sender)

Description copied from class: MessageDecoder

Handle "Identify Event" message

Overrides:

handleIdentifyEventsAddressed in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

handleIdentifyEventsGlobal

public void handleIdentifyEventsGlobal(IdentifyEventsGlobalMessage msg,
                                       Connection sender)

Description copied from class: MessageDecoder

Handle "Identify Event Global" message

Overrides:

handleIdentifyEventsGlobal in class MessageDecoder

Parameters:

msg - message to handle

sender - connection where it came from

setValueFromNetwork

private void setValueFromNetwork(boolean isOn)