icube.demo.io

Class COMChannel

java.lang.Object

icube.demo.io.COMChannel

All Implemented Interfaces:

IChannel

public final class COMChannel
extends java.lang.Object
implements IChannel

Implements the serial port communication resource.

We are using RxTxSerial package to access the serial-port.

See also: RxTx home page.

See also: Serial Programming wikibook.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABITS_7
static int	DATABITS_8
static int	PARITY_EVEN
static int	PARITY_NONE
static int	PARITY_ODD
static int	STOPBITS_1
static int	STOPBITS_1_5
static int	STOPBITS_2

Constructor Summary

Constructors

Constructor and Description
COMChannel(java.lang.String portName) Creates a new instance of COMChannel creating a serial port for the specified portName.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the communication channel.
void	configure(int baudRate, int dataBits, int stopBits, int parity) Configure.
java.lang.String	getID() Returns the communication channel ID.
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream()
boolean	isOpen() Returns the open status of the communication channel.
void	open(int timeout) Opens the communication channel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATABITS_7

public static final int DATABITS_7

See Also:

Constant Field Values

DATABITS_8

public static final int DATABITS_8

See Also:

Constant Field Values

PARITY_NONE

public static final int PARITY_NONE

See Also:

Constant Field Values

PARITY_ODD

public static final int PARITY_ODD

See Also:

Constant Field Values

PARITY_EVEN

public static final int PARITY_EVEN

See Also:

Constant Field Values

STOPBITS_1

public static final int STOPBITS_1

See Also:

Constant Field Values

STOPBITS_2

public static final int STOPBITS_2

See Also:

Constant Field Values

STOPBITS_1_5

public static final int STOPBITS_1_5

See Also:

Constant Field Values

Constructor Detail

COMChannel

public COMChannel(java.lang.String portName)
           throws ChannelException

Creates a new instance of COMChannel creating a serial port for the specified portName.

Parameters:

portName - The name of the port to create.

Throws:

ChannelException - Thrown for any detected error.

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Specified by:

getInputStream in interface IChannel

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Specified by:

getOutputStream in interface IChannel

Throws:

java.io.IOException

open

public void open(int timeout)
          throws ChannelException

Description copied from interface: IChannel

Opens the communication channel.

Specified by:

open in interface IChannel

Parameters:

timeout - Default Timeout (in ms) to be used for all read actions.

Throws:

ChannelException - Thrown for any detected error.

close

public void close()

Description copied from interface: IChannel

Closes the communication channel.

Specified by:

close in interface IChannel

configure

public void configure(int baudRate,
                      int dataBits,
                      int stopBits,
                      int parity)
               throws ChannelException

Configure.

Parameters:

baudRate -

dataBits -

stopBits -

parity -

Throws:

ChannelException

getID

public java.lang.String getID()

Description copied from interface: IChannel

Returns the communication channel ID. (i.e. COM1, ...)

Specified by:

getID in interface IChannel

Returns:

Channel ID.

isOpen

public boolean isOpen()

Description copied from interface: IChannel

Returns the open status of the communication channel.

Specified by:

isOpen in interface IChannel

Returns:

true if is open.