Package jisa.addresses

Class SerialAddress

java.lang.Object

jisa.addresses.SerialAddress

All Implemented Interfaces:

Address

public class SerialAddress
extends java.lang.Object
implements Address

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SerialAddress.Baud
static class	SerialAddress.Data
static class	SerialAddress.Parity
static class	SerialAddress.Stop

Nested classes/interfaces inherited from interface jisa.addresses.Address

Address.AddressInstantiator<A extends Address>

Field Summary

Fields inherited from interface jisa.addresses.Address

TYPES

Constructor Summary

Constructors

Constructor	Description
SerialAddress()
SerialAddress(int asrlNum)
SerialAddress(java.lang.String portName)
SerialAddress(java.lang.String portName, int asrlNum)
SerialAddress(java.util.Map<java.lang.String,java.lang.Object> parameters)

Method Summary

Modifier and Type	Method	Description
int	getASRLNum()
SerialAddress.Baud	getBaudRate()
SerialAddress.Data	getDataBits()
java.lang.String	getJISAString()	Returns the JISA text representation of this address (may vary from the VISA representation in some cases).
java.util.Map<java.lang.String,java.lang.Object>	getParameters()	Returns a map of this address' configurable parameters.
SerialAddress.Parity	getParity()
java.lang.String	getPortName()
SerialAddress.Stop	getStopBits()
java.lang.String	getTypeName()	Returns a textual representation of this address' type.
java.lang.String	getVISAString()	Returns the standard VISA text representation of this address.
boolean	hasParametersSpecified()
void	parseString(java.lang.String text)	Parses a text representation of this type of address, setting its parameters based on those in the text.
void	setBaudRate(SerialAddress.Baud baudRate)
void	setDataBits(SerialAddress.Data dataBits)
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)	Set the parameters of this address from a given map.
void	setParity(SerialAddress.Parity parity)
void	setPortName(java.lang.String portName)
void	setStopBits(SerialAddress.Stop stopBits)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialAddress

public SerialAddress()

SerialAddress

public SerialAddress(java.lang.String portName,
                     int asrlNum)

SerialAddress

public SerialAddress(java.lang.String portName)

SerialAddress

public SerialAddress(int asrlNum)

SerialAddress

public SerialAddress(java.util.Map<java.lang.String,java.lang.Object> parameters)

Method Detail

getPortName

public java.lang.String getPortName()

getASRLNum

public int getASRLNum()

setPortName

public void setPortName(java.lang.String portName)

getBaudRate

public SerialAddress.Baud getBaudRate()

setBaudRate

public void setBaudRate(SerialAddress.Baud baudRate)

getDataBits

public SerialAddress.Data getDataBits()

setDataBits

public void setDataBits(SerialAddress.Data dataBits)

getParity

public SerialAddress.Parity getParity()

setParity

public void setParity(SerialAddress.Parity parity)

getStopBits

public SerialAddress.Stop getStopBits()

setStopBits

public void setStopBits(SerialAddress.Stop stopBits)

getTypeName

public java.lang.String getTypeName()

Description copied from interface: Address

Returns a textual representation of this address' type.

Specified by:

getTypeName in interface Address

Returns:

Type of address

getVISAString

public java.lang.String getVISAString()

Description copied from interface: Address

Returns the standard VISA text representation of this address.

Specified by:

getVISAString in interface Address

Returns:

VISA text representation

getJISAString

public java.lang.String getJISAString()

Description copied from interface: Address

Returns the JISA text representation of this address (may vary from the VISA representation in some cases).

Specified by:

getJISAString in interface Address

Returns:

JISA text representation

hasParametersSpecified

public boolean hasParametersSpecified()

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Description copied from interface: Address

Returns a map of this address' configurable parameters.

Specified by:

getParameters in interface Address

Returns:

Map of parameters

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: Address

Set the parameters of this address from a given map.

Specified by:

setParameters in interface Address

Parameters:

parameters - Map of parameters to set

parseString

public void parseString(java.lang.String text)
                 throws InvalidAddressFormatException

Description copied from interface: Address

Parses a text representation of this type of address, setting its parameters based on those in the text.

Specified by:

parseString in interface Address

Parameters:

text - VISA/JISA text representation

Throws:

InvalidAddressFormatException - If the text representation is not formatted properly for this address type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object