Class portio.SerialPortParams
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class portio.SerialPortParams

java.lang.Object
   |
   +----portio.PortParams
           |
           +----portio.SerialPortParams

public class SerialPortParams
extends PortParams
implements Cloneable
Port parameters for standard RS-232 serial ports. This serves simply as a parameter block and provides no associated methods. Use the SerialPort.setParams to set parameters. Note that the PortParams class itself is empty.
Version:
$Revision: 2.1 $ ($Date: 1997/02/19 18:00:00 $)
See Also:
Port, SerialPort

Variable Index

 o carrierSense
causes eof (-1) to be returned on reads and writes upon loss of carrier (DCD)
 o charSize
Character size; typically 5, 6, 7, or 8 bits/character.
 o exceptionOnBreak
This causes an exception to be generated on reads if a break condition is received.
 o exceptionOnFramingError
This causes an exception to be thrown on reads if a framing error is encountered.
 o exceptionOnOverrunError
This causes an exception to be thrown on reads if an overrun error is encountered.
 o exceptionOnParityError
This causes an exception to be thrown on reads if a parity error is encountered.
 o FLOW_IN_DTR
input hardware flow control mode, uses DTR to pace input (used by some printers but optionally supported--make a special cable to route RTS on the port to DTR on such printers when not supported)
 o FLOW_IN_RTS
input hardware flow control mode, uses RTS to pace input (most common)
 o FLOW_IXANY
IXANY output mode (any character restarts stopped output)
 o FLOW_NONE
no flow control mode
 o FLOW_OUT_CTS
output hardware flow control mode, uses CTS to pace output (most common)
 o FLOW_OUT_DCD
output hardware flow control mode, uses DCD to pace output (optional)
 o FLOW_OUT_DSR
output hardware flow control mode, uses DSR to pace output (optional)
 o FLOW_SOFTWARE
software flow control mode
 o flowStart
software flow control start character
 o flowStop
software flow control stop character
 o framing
Framing bits, typically 1, 1.5, and 2 are legal values.
 o inBaud
Input baud rate
 o inFlowControl
input flow control mode (mode values can be OR'd together)
 o loopback
optionally implemented, sets hardware loopback for testing
 o outBaud
Output baud rate
 o outFlowControl
output flow control mode (mode values can be OR'd together)
 o parity
Parity bit code
 o PARITY_EVEN
even parity
 o PARITY_MARK
mark parity
 o PARITY_NONE
no parity
 o PARITY_ODD
odd parity
 o PARITY_SPACE
space parity
 o receiveEnable
optionally implemented, enables/disable receiver at hardware level

Constructor Index

 o SerialPortParams()
Instantiates a default serial port params object defaulting to 9600, 8, N, 1 with no flow control, receive enabled, and start/stop chars set to the usual Control-S and Control-Q.

Method Index

 o clone()
Clones the port params object.
 o toString()
Converts the object to a string.

Variables

 o PARITY_NONE
  public final static int PARITY_NONE
no parity
 o PARITY_ODD
  public final static int PARITY_ODD
odd parity
 o PARITY_EVEN
  public final static int PARITY_EVEN
even parity
 o PARITY_MARK
  public final static int PARITY_MARK
mark parity
 o PARITY_SPACE
  public final static int PARITY_SPACE
space parity
 o FLOW_NONE
  public final static int FLOW_NONE
no flow control mode
 o FLOW_SOFTWARE
  public final static int FLOW_SOFTWARE
software flow control mode
 o FLOW_IXANY
  public final static int FLOW_IXANY
IXANY output mode (any character restarts stopped output)
 o FLOW_OUT_CTS
  public final static int FLOW_OUT_CTS
output hardware flow control mode, uses CTS to pace output (most common)
 o FLOW_OUT_DSR
  public final static int FLOW_OUT_DSR
output hardware flow control mode, uses DSR to pace output (optional)
 o FLOW_OUT_DCD
  public final static int FLOW_OUT_DCD
output hardware flow control mode, uses DCD to pace output (optional)
 o FLOW_IN_RTS
  public final static int FLOW_IN_RTS
input hardware flow control mode, uses RTS to pace input (most common)
 o FLOW_IN_DTR
  public final static int FLOW_IN_DTR
input hardware flow control mode, uses DTR to pace input (used by some printers but optionally supported--make a special cable to route RTS on the port to DTR on such printers when not supported)
 o outBaud
  public int outBaud
Output baud rate
 o inBaud
  public int inBaud
Input baud rate
 o charSize
  public int charSize
Character size; typically 5, 6, 7, or 8 bits/character.
 o parity
  public int parity
Parity bit code
 o framing
  public double framing
Framing bits, typically 1, 1.5, and 2 are legal values. Some hardware support other fractional stop bit settings. It's up to the driver to determine what is supported and how to round values.
 o outFlowControl
  public int outFlowControl
output flow control mode (mode values can be OR'd together)
 o inFlowControl
  public int inFlowControl
input flow control mode (mode values can be OR'd together)
 o flowStart
  public byte flowStart
software flow control start character
 o flowStop
  public byte flowStop
software flow control stop character
 o carrierSense
  public boolean carrierSense
causes eof (-1) to be returned on reads and writes upon loss of carrier (DCD)
 o exceptionOnParityError
  public boolean exceptionOnParityError
This causes an exception to be thrown on reads if a parity error is encountered. Regardless of the setting of this flag, error characters are placed on the input stream as read from the hardware.
 o exceptionOnFramingError
  public boolean exceptionOnFramingError
This causes an exception to be thrown on reads if a framing error is encountered. Regardless of the setting of this flag, error characters are placed on the input stream as read from the hardware.
 o exceptionOnOverrunError
  public boolean exceptionOnOverrunError
This causes an exception to be thrown on reads if an overrun error is encountered.
 o exceptionOnBreak
  public boolean exceptionOnBreak
This causes an exception to be generated on reads if a break condition is received. Regardless of the setting of this flag, the break will appear as one or more zero bytes on the input stream.
 o receiveEnable
  public boolean receiveEnable
optionally implemented, enables/disable receiver at hardware level
 o loopback
  public boolean loopback
optionally implemented, sets hardware loopback for testing

Constructors

 o SerialPortParams
  public SerialPortParams()
Instantiates a default serial port params object defaulting to 9600, 8, N, 1 with no flow control, receive enabled, and start/stop chars set to the usual Control-S and Control-Q. This is the default parameter set that serial ports should be set to on open for this package.

Methods

 o toString
  public String toString()
Converts the object to a string.
Overrides:
toString in class Object
 o clone
  public Object clone()
Clones the port params object.
Overrides:
clone in class Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index