ChannelEvent describes a read event on the channel. More...

Inherits EventObject.

Public Member Functions
	ChannelReadEvent (Channel source, TDataType rawValue, int status, String statusString, boolean successful)
	Construct a new read event. More...

Channel	getChannel ()
	Returns the channel, which is always the source of this event. More...

TDataType	getRawValue ()
	Returns the raw value that was read from the channel. More...

int	getStatus ()
	Returns the status code of the read action. More...

String	getStatusString ()
	Returns the status code in a human readable text. More...

boolean	isSuccessful ()
	Returns true if this event describes an action completed successfully, or false if the action was completed with an error. More...

Detailed Description

ChannelEvent describes a read event on the channel.

It contains the reference to the source channel as well as the read value and status.

Constructor & Destructor Documentation

de.desy.tine.accesslayer.ChannelReadEvent.ChannelReadEvent	(	Channel	source,
		TDataType	rawValue,
		int	status,
		String	statusString,
		boolean	successful
	)

Construct a new read event.

Parameters

source	the source of the event
rawValue	the value
status	the status code
statusString	the human readable representation of the status code
successful	indicates if this event describes a success (true) or an error (false)

Channel de.desy.tine.accesslayer.ChannelReadEvent.getChannel ( )

Returns the channel, which is always the source of this event.

TDataType de.desy.tine.accesslayer.ChannelReadEvent.getRawValue ( )

Returns the raw value that was read from the channel.

int de.desy.tine.accesslayer.ChannelReadEvent.getStatus ( )

Returns the status code of the read action.

String de.desy.tine.accesslayer.ChannelReadEvent.getStatusString ( )

Returns the status code in a human readable text.

boolean de.desy.tine.accesslayer.ChannelReadEvent.isSuccessful ( )

Returns true if this event describes an action completed successfully, or false if the action was completed with an error.

The documentation for this class was generated from the following file: