com.fivecolibs.devices

Class FCOCPortSerial

java.lang.Object

com.fivecolibs.devices.FCOCPortSerial

All Implemented Interfaces:

FCOIPort

public class FCOCPortSerial
extends java.lang.Object
implements FCOIPort

Serial Communication port for FCOCDevice

Version:

1.1

Author:

agardiol

Constructor Summary

Constructors

Constructor and Description
FCOCPortSerial(java.lang.String szComPort, int nBaudRate) Create a new serial port

Method Summary

Modifier and Type	Method and Description
int	available() Get number of available bytes in receive buffer
void	close() Ask to close the communication port
void	discardInputBuffer() Discards data from the receive buffer.
int	getBaudRate()
java.lang.String	getComPort()
int	getData(byte[] acBuffer, int nOffset, int nLength) Get data from the communication port
int	getData(byte[] acBuffer, int nOffset, int nLength, int nTimeout) Get data from the communication port
com.fivecolibs.devices.FCOEPortState	getState()
void	open() Ask to open the communication port
void	putData(byte[] acBuffer, int nOffset, int nLength) Send data through the communication port

Methods inherited from class java.lang.Object

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

Constructor Detail

FCOCPortSerial

public FCOCPortSerial(java.lang.String szComPort,
                      int nBaudRate)

Create a new serial port

Parameters:

szComPort - Serial communication port

nBaudRate - Baud rate (real value)

Method Detail

getComPort

public java.lang.String getComPort()

Returns:

Defined Com Port name

getBaudRate

public int getBaudRate()

Returns:

Defined baud rate

getState

public com.fivecolibs.devices.FCOEPortState getState()

Specified by:

getState in interface FCOIPort

Returns:

Actual port state

open

public void open()
          throws java.io.IOException

Description copied from interface: FCOIPort

Ask to open the communication port

Specified by:

open in interface FCOIPort

Throws:

java.io.IOException - If open fails

close

public void close()

Description copied from interface: FCOIPort

Ask to close the communication port

Specified by:

close in interface FCOIPort

putData

public void putData(byte[] acBuffer,
                    int nOffset,
                    int nLength)
             throws java.io.IOException

Description copied from interface: FCOIPort

Send data through the communication port

Specified by:

putData in interface FCOIPort

Parameters:

acBuffer - The buffer of data to output

nOffset - The offset in the buffer where data will be sent from

nLength - The length of data that will be sent beginning at the offset

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

getData

public int getData(byte[] acBuffer,
                   int nOffset,
                   int nLength)
            throws java.io.IOException

Description copied from interface: FCOIPort

Get data from the communication port

Specified by:

getData in interface FCOIPort

Parameters:

acBuffer - Buffer where data will be put when read

nOffset - The offset in the buffer where data will be put

nLength - The maximum length of data requested to be put in the buffer

Returns:

The total number of bytes read into the buffer

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

getData

public int getData(byte[] acBuffer,
                   int nOffset,
                   int nLength,
                   int nTimeout)
            throws java.io.IOException

Description copied from interface: FCOIPort

Get data from the communication port

Specified by:

getData in interface FCOIPort

Parameters:

acBuffer - Buffer where data will be put when read

nOffset - The offset in the buffer where data will be put

nLength - The maximum length of data requested to be put in the buffer

nTimeout - The time in millisecond to wait if the nLength is not reached.

Returns:

The total number of bytes read into the buffer

Throws:

java.io.IOException - If an exception occurs in the underlying communication system

discardInputBuffer

public void discardInputBuffer()

Description copied from interface: FCOIPort

Discards data from the receive buffer.

Specified by:

discardInputBuffer in interface FCOIPort

available

public int available()
              throws java.io.IOException

Description copied from interface: FCOIPort

Get number of available bytes in receive buffer

Specified by:

available in interface FCOIPort

Returns:

Number of bytes available in rx buffer

Throws:

java.io.IOException - Input stream exception