GHASerialPortBase Class

[This is preliminary documentation and is subject to change.]

Defines the base class for all objects in the GHA system

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    GHAObject
      GHASchema.Classes.Device.InputOutputGHASerialPortBase

Namespace: GHASchema.Classes.Device.InputOutput
Assembly: GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)

Syntax

[SerializableAttribute]
public abstract class GHASerialPortBase : GHAObject, 
	ISerialPort

The GHASerialPortBase type exposes the following members.

Constructors

	Name	Description
	GHASerialPortBase	Initializes a new instance of the GHASerialPortBase class

Properties

	Name	Description
	BaudRate	Defines the speed (baud rate) for the serial port
	BytesAvailable	Number of bytes available in the read stream
	CTS	Sets the Clear to send bit
	DataBits	Defines the number of data bits to use for the serial port
	DataReceived	Momentary, set when new data is available from the serial port.
	DSR	Sets the Data Set Ready bit
	DTR	Sets the Data Terminal Ready bit
	EndOfMessageMarker	Defines the character that the driver will use to determine if a received message is complete
	ErrorReceived	Momentary, set when the serial port detects an error
	FlowControl	Defines the desired flow-control for the serial port
	IsOpen	Determines if serial port is in-use (true) or available (false)
	IsTextOriented	Determines if the serial port exclusively sends standard printable characters (true) versus binary (false)
	Parity	Defines the parity setting for the serial port
	Reset	Momentary, initiates a reset of the port
	RTS	Sets the request to send bit
	StatusCTS	Reads the status of the Clear to send bit
	StatusDSR	Reads the status of the Data set ready bit
	StatusRing	Reads the status of the Ring bit
	StopBits	Defines the number of stop bits for the serial port

Methods

	Name	Description
	Close	Closes the serial port
	Open	Opens the serial port
	Read	Reads data from the serial port
	ReadLine	Reads a line of text from the serial port
	Write(String)	Writes a line of text without a terminator character
	Write(Byte, Int32, Int32)	Writes a byte buffer to the serial port
	WriteLine	Writes a line of text to the serial port with a termination character