CbusEventInterface (JMRI API)

All Known Implementing Classes:: CbusLight, CbusSensor, CbusTurnout

public interface CbusEventInterface

Interface for CBUS Sensors, Turnouts and Lights to report CBUS Events.

Method Summary

Modifier and Type

Method

Description

default CanMessage

checkEvent(CanMessage m)

Check if CanMessage is an event.

CanMessage

getBeanOffMessage()

Get event for primary Bean Off Action.

CanMessage

getBeanOnMessage()

Get event for primary Bean On Action.

Method Details
- getBeanOnMessage
  
  @CheckForNull CanMessage getBeanOnMessage()
  
  Get event for primary Bean On Action. e.g. without inversion, Light On.
  
  Returns:
  
  Event for the Action, may be null
- getBeanOffMessage
  
  @CheckForNull CanMessage getBeanOffMessage()
  
  Get event for primary Bean Off Action. e.g. without Inversion Light Off.
  
  Returns:
  
  Event for the Action, may be null
- checkEvent
  
  @CheckForNull default CanMessage checkEvent(CanMessage m)
  
  Check if CanMessage is an event.
  
  Parameters:
  
  m - CAN Frame to test.
  
  Returns:
  
  Passed CanMessage if event, else null.