Module vcr4j.rs422

Package org.mbari.vcr4j.rs422

Class RS422Error

java.lang.Object

org.mbari.vcr4j.rs422.RS422Error

All Implemented Interfaces:

VideoError

public class RS422Error
extends Object
implements VideoError

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHECKSUM_ERROR	SONY - Checksum error in the command sent
static final int	FRAMING_ERROR	SONY - VCR reports a serial framing error
static final int	OK	Everything is OK
static final int	OTHER_ERROR
static final int	OVERRUN_ERROR	SONY - Overran the VCR's command buffer
static final int	PARITY_ERROR	SONY - Parity error on a command byte
static final int	TIMEOUT	SONY - VCR reports Timeout on recieving command
static final int	UNDEFINED_COMMAND	SONY - Invalid command sent to VCR

Constructor Summary

Constructors

Constructor	Description
RS422Error(int error)
RS422Error(int error, String errorMsg, VideoCommand<?> videoCommand)
RS422Error(int error, VideoCommand<?> videoCommand)
RS422Error(String errorMsg)
RS422Error(String errorMsg, VideoCommand<?> videoCommand)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	RS422Error objects are equal if they have the same error code
int	getError()	Although this is a potentially useful method.
String	getMessage()
Optional<VideoCommand<?>>	getVideoCommand()
boolean	hasError()
int	hashCode()
boolean	isChecksumError()
boolean	isFramingError()
boolean	isOK()
boolean	isOverrunError()
boolean	isParityError()
boolean	isTimeout()
boolean	isUndefinedCommand()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

OTHER_ERROR

public static final int OTHER_ERROR

See Also:

• Constant Field Values

CHECKSUM_ERROR

public static final int CHECKSUM_ERROR

SONY - Checksum error in the command sent

See Also:

• Constant Field Values

FRAMING_ERROR

public static final int FRAMING_ERROR

SONY - VCR reports a serial framing error

See Also:

• Constant Field Values

OK

public static final int OK

Everything is OK

See Also:

• Constant Field Values

OVERRUN_ERROR

public static final int OVERRUN_ERROR

SONY - Overran the VCR's command buffer

See Also:

• Constant Field Values

PARITY_ERROR

public static final int PARITY_ERROR

SONY - Parity error on a command byte

See Also:

• Constant Field Values

TIMEOUT

public static final int TIMEOUT

SONY - VCR reports Timeout on recieving command

See Also:

• Constant Field Values

UNDEFINED_COMMAND

public static final int UNDEFINED_COMMAND

SONY - Invalid command sent to VCR

See Also:

• Constant Field Values

Constructor Details

RS422Error

public RS422Error(int error)

RS422Error

public RS422Error(int error,
 VideoCommand<?> videoCommand)

RS422Error

public RS422Error(String errorMsg)

RS422Error

public RS422Error(String errorMsg,
 VideoCommand<?> videoCommand)

RS422Error

public RS422Error(int error,
 String errorMsg,
 VideoCommand<?> videoCommand)

Method Details

isChecksumError

public boolean isChecksumError()

getError

public int getError()

Although this is a potentially useful method. Most programs will be getter served by the getErrorMsg() or toString() methods.

Returns:

the integer error code

hasError

public boolean hasError()

Specified by:

hasError in interface VideoError

Returns:

true if an error condition occurred in response to a command

isFramingError

public boolean isFramingError()

isOK

public boolean isOK()

isOverrunError

public boolean isOverrunError()

isParityError

public boolean isParityError()

isTimeout

public boolean isTimeout()

isUndefinedCommand

public boolean isUndefinedCommand()

getVideoCommand

public Optional<VideoCommand<?>> getVideoCommand()

Specified by:

getVideoCommand in interface VideoError

Returns:

The command that triggered the error

getMessage

public String getMessage()

equals

public boolean equals(Object o)

RS422Error objects are equal if they have the same error code

Overrides:

equals in class Object

Parameters:

o - The object to be compared

Returns:

true if equals

hashCode

public int hashCode()

Overrides:

hashCode in class Object