org.epics.pvmanager

Class PVWriterEvent<T>

java.lang.Object

org.epics.pvmanager.PVWriterEvent<T>

Type Parameters:

T - the type of the writer

public class PVWriterEvent<T>
extends Object

An event for the writer.

An event can be trigger by:

• a connection change; the connection either connected or disconnected
• an exception; an error either at the datasource or while preparing the write values
• a write has concluded

One event can have multiple triggers. You can use the mask or the methods to check what condition applies.

Author:

carcassi

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECTION_MASK Mask for connection event.
static int	EXCEPTION_MASK Mask for error event.
static int	WRITE_FAILED_MASK Mask for a failed write result.
static int	WRITE_SUCCEEDED_MASK Mask for a successful write result.

Method Summary

Methods

Modifier and Type	Method and Description
int	getNotificationMask() The mask for the event.
PVWriter<T>	getPvWriter() The writer that generated the event.
boolean	isConnectionChanged() Whether this event was generated by a connection change.
boolean	isExceptionChanged() Whether this event was generated in response to an error.
boolean	isWriteFailed() Whether this event waas generated in response to a failed write operation.
boolean	isWriteSucceeded() Whether this event was generated in response to a successful write operation.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTION_MASK

public static int CONNECTION_MASK

Mask for connection event.

EXCEPTION_MASK

public static int EXCEPTION_MASK

Mask for error event.

WRITE_SUCCEEDED_MASK

public static int WRITE_SUCCEEDED_MASK

Mask for a successful write result.

WRITE_FAILED_MASK

public static int WRITE_FAILED_MASK

Mask for a failed write result.

Method Detail

getPvWriter

public PVWriter<T> getPvWriter()

The writer that generated the event.

Returns:

the pv writer

getNotificationMask

public int getNotificationMask()

The mask for the event.

Returns:

event mask

isConnectionChanged

public boolean isConnectionChanged()

Whether this event was generated by a connection change.

Returns:

true if the connection status changed from the last notification

isWriteSucceeded

public boolean isWriteSucceeded()

Whether this event was generated in response to a successful write operation.

Returns:

true if the write operation was concluded successfully

isWriteFailed

public boolean isWriteFailed()

Whether this event waas generated in response to a failed write operation.

Returns:

true if the write operation was concluded unsuccessfully

isExceptionChanged

public boolean isExceptionChanged()

Whether this event was generated in response to an error.

Returns:

true if a new exception is available

toString

public String toString()

Overrides:

toString in class Object