Package jmri.jmrix.purejavacomm

Class SerialPortEvent

java.lang.Object

java.util.EventObject

jmri.jmrix.purejavacomm.SerialPortEvent

All Implemented Interfaces:

Serializable

public class SerialPortEvent
extends EventObject

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BI	Break interrupt.
static final int	CD	Carrier detect.
static final int	CTS	Clear to send.
static final int	DATA_AVAILABLE	Data available at the serial port.
static final int	DSR	Data set ready.
static final int	FE	Framing error.
static final int	OE	Overrun error.
static final int	OUTPUT_BUFFER_EMPTY	Output buffer is empty.
static final int	PE	Parity error.
static final int	RI	Ring indicator.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SerialPortEvent(SerialPort source, int eventType, boolean oldValue, boolean newValue)	Constructs a SerialPortEvent with the specified serial port, event type, old and new values.

Method Summary

Modifier and Type	Method	Description
int	getEventType()	Returns the type of this event.
boolean	getNewValue()	Returns the new value of the state change that caused the SerialPortEvent to be propagated.
boolean	getOldValue()	Returns the old value of the state change that caused the SerialPortEvent to be propagated.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Details

DATA_AVAILABLE

public static final int DATA_AVAILABLE

Data available at the serial port.

See Also:

• Constant Field Values

OUTPUT_BUFFER_EMPTY

public static final int OUTPUT_BUFFER_EMPTY

Output buffer is empty.

See Also:

• Constant Field Values

CTS

public static final int CTS

Clear to send.

See Also:

• Constant Field Values

DSR

public static final int DSR

Data set ready.

See Also:

• Constant Field Values

RI

public static final int RI

Ring indicator.

See Also:

• Constant Field Values

CD

public static final int CD

Carrier detect.

See Also:

• Constant Field Values

OE

public static final int OE

Overrun error.

See Also:

• Constant Field Values

PE

public static final int PE

Parity error.

See Also:

• Constant Field Values

FE

public static final int FE

Framing error.

See Also:

• Constant Field Values

BI

public static final int BI

Break interrupt.

See Also:

• Constant Field Values

Constructor Details

SerialPortEvent

public SerialPortEvent(SerialPort source,
 int eventType,
 boolean oldValue,
 boolean newValue)

Constructs a SerialPortEvent with the specified serial port, event type, old and new values. Application programs should not directly create SerialPortEvent objects.

Parameters:

source - the source

eventType - the event type

oldValue - the old value

newValue - the new value

Method Details

getEventType

public int getEventType()

Returns the type of this event.

Returns:

The type of this event.

getNewValue

public boolean getNewValue()

Returns the new value of the state change that caused the SerialPortEvent to be propagated.

Returns:

The new value of the state change.

getOldValue

public boolean getOldValue()

Returns the old value of the state change that caused the SerialPortEvent to be propagated.

Returns:

The old value of the state change.