Libraries.System.SerialPort Documentation
This is an implementation of a Serial Port in Quorum. It provides for very basic querying of the port, like its system names, and allows us to open and close it. More information about Serial Ports can be found on Wikipedia: https://en.wikipedia.org/wiki/Serial_port
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Close() | Closes the port. |
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetDescription() | Returns a description of the port. |
GetDescriptiveName() | Returns a potentially more descriptive name for the port. |
GetHashCode() | This action gets the hash code for an object. |
GetName() | Returns the system's name for the port. |
Open() | Opens the port. |
Open(integer timeout) | Opens the port with a timeout. |
Read() | Reads from the port. |
Write(text value) | Writes to the port. |
Actions Documentation
Close()
Closes the port.
Return
boolean:
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetDescription()
Returns a description of the port.
Return
text:
GetDescriptiveName()
Returns a potentially more descriptive name for the port.
Return
text:
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetName()
Returns the system's name for the port.
Return
text:
Open()
Opens the port.
Return
boolean:
Open(integer timeout)
Opens the port with a timeout.
Parameters
Return
boolean:
Read()
Reads from the port.
Return
text:
Write(text value)
Writes to the port.