Package jisa.visa.drivers

Class SerialDriver.JSSCConnection

java.lang.Object

jisa.visa.drivers.SerialDriver.JSSCConnection

All Implemented Interfaces:

Connection, SerialConnection

Enclosing class:

SerialDriver

public static class SerialDriver.JSSCConnection
extends java.lang.Object
implements SerialConnection

Nested Class Summary

Nested classes/interfaces inherited from interface jisa.visa.connections.SerialConnection

SerialConnection.FlowControl, SerialConnection.Parity, SerialConnection.Stop

Constructor Summary

Constructors

Constructor	Description
JSSCConnection(jssc.SerialPort comPort)

Method Summary

Modifier and Type	Method	Description
void	clear()
void	close()	Closes the connection, freeing up the resources used by it.
java.nio.charset.Charset	getEncoding()
void	overrideSerialParameters(int baud, int data, SerialConnection.Parity parity, SerialConnection.Stop stop)
byte[]	readBytes(int bufferSize)	Attempts to read the given number of bytes from the connection.
void	setEncoding(java.nio.charset.Charset charset)
void	setReadTerminator(long character)	Sets the "End of String" terminator, in numerical form.
void	setReadTerminator(java.lang.String character)	Sets the "End of String" terminator, in String form.
void	setSerialParameters(int baud, int data, SerialConnection.Parity parity, SerialConnection.Stop stop, SerialConnection.FlowControl... flows)
void	setTimeout(int timeout)	Sets the time-out, in milli-seconds, to use on this connection.
void	write(java.lang.String toWrite)	Writes the specified string over the connection.
void	writeBytes(byte[] bytes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jisa.visa.connections.Connection

read, read

Methods inherited from interface jisa.visa.connections.SerialConnection

setSerialParameters

Constructor Detail

JSSCConnection

public JSSCConnection(jssc.SerialPort comPort)
               throws VISAException

Throws:

VISAException

Method Detail

writeBytes

public void writeBytes(byte[] bytes)
                throws VISAException

Specified by:

writeBytes in interface Connection

Throws:

VISAException

clear

public void clear()
           throws VISAException

Specified by:

clear in interface Connection

Throws:

VISAException

setEncoding

public void setEncoding(java.nio.charset.Charset charset)

Specified by:

setEncoding in interface Connection

getEncoding

public java.nio.charset.Charset getEncoding()

Specified by:

getEncoding in interface Connection

write

public void write(java.lang.String toWrite)
           throws VISAException

Description copied from interface: Connection

Writes the specified string over the connection.

Specified by:

write in interface Connection

Parameters:

toWrite - String to write

Throws:

VISAException - Upon something going wrong with VISA

readBytes

public byte[] readBytes(int bufferSize)
                 throws VISAException

Description copied from interface: Connection

Attempts to read the given number of bytes from the connection. Will return if either the number of bytes is reached or the specified EOS terminator is found. Will time-out if neither of these conditions are met within the value specified by setTMO(...).

Specified by:

readBytes in interface Connection

Parameters:

bufferSize - The number of bytes to read

Returns:

Array of bytes read (trimmed)

Throws:

VISAException - Upon something going wrong

setReadTerminator

public void setReadTerminator(long character)

Description copied from interface: Connection

Sets the "End of String" terminator, in numerical form. This is the terminator used for reading from the connection, to specify the end of a message from the instrument. For example:

line-feed: \n = 0x0A carriage-return \r = 0x0D CR-LF \r\n = 0x0D0A

Specified by:

setReadTerminator in interface Connection

Parameters:

character - The terminator to look for (numerical representation)

setReadTerminator

public void setReadTerminator(java.lang.String character)

Description copied from interface: Connection

Sets the "End of String" terminator, in String form. This is the terminator used for reading from the connection, to specify the end of a message from the instrument.

Specified by:

setReadTerminator in interface Connection

Parameters:

character - The terminator to look from (String representation)

setTimeout

public void setTimeout(int timeout)
                throws VISAException

Description copied from interface: Connection

Sets the time-out, in milli-seconds, to use on this connection.

Specified by:

setTimeout in interface Connection

Parameters:

timeout - Time-out, in milli-seconds

Throws:

VISAException - Upon something going wrong

overrideSerialParameters

public void overrideSerialParameters(int baud,
                                     int data,
                                     SerialConnection.Parity parity,
                                     SerialConnection.Stop stop)
                              throws VISAException

Throws:

VISAException

setSerialParameters

public void setSerialParameters(int baud,
                                int data,
                                SerialConnection.Parity parity,
                                SerialConnection.Stop stop,
                                SerialConnection.FlowControl... flows)
                         throws VISAException

Specified by:

setSerialParameters in interface SerialConnection

Throws:

VISAException

close

public void close()
           throws VISAException

Description copied from interface: Connection

Closes the connection, freeing up the resources used by it.

Specified by:

close in interface Connection

Throws:

VISAException - Upon something going wrong