CanInterface (JMRI API)

All Known Implementing Classes:: AbstractCanTrafficController, GcTrafficController, LawicellTrafficController, LoopbackTrafficController, MergTrafficController, TrafficController

public interface CanInterface

Define interface for sending and receiving CAN messages

Method Summary

Modifier and Type

Method

Description

void

addCanListener(CanListener l)

void

removeCanListener(CanListener l)

void

sendCanMessage(CanMessage m, CanListener l)

Send a message through the interface.

void

sendCanReply(CanReply r, CanListener l)

Send a reply through the interface.

boolean

status()

Test operational status of interface.

Method Details
- addCanListener
  
  void addCanListener(CanListener l)
- removeCanListener
  
  void removeCanListener(CanListener l)
- status
  
  boolean status()
  
  Test operational status of interface.
  
  Returns:
  
  true is interface implementation is operational.
- sendCanMessage
  
  void sendCanMessage(CanMessage m, CanListener l)
  
  Send a message through the interface.
  
  Parameters:
  
  m - Message to be sent.
  
  l - Listener to be notified of reply.
- sendCanReply
  
  void sendCanReply(CanReply r, CanListener l)
  
  Send a reply through the interface.
  
  Parameters:
  
  r - Reply to be sent.
  
  l - Listener to be notified of reply.