org.mbari.siam.core
Class NullPowerPort

java.lang.Object
  org.mbari.siam.core.NullPowerPort

All Implemented Interfaces:

PowerPort

public class NullPowerPort
extends java.lang.Object
implements PowerPort

Implementation of PowerPort interface; used when power control hardware is absent.

Author:

Tom O'Reilly

Field Summary

static java.lang.String

TYPE_NAME

Constructor Summary

NullPowerPort()

Method Summary

void	connectPower() Connect instrument to power.
void	disableCommunications() Disable communications
void	disconnectPower() Disconnect instrument from power.
void	enableCommunications() Enable communications
float	getCurrentLevel() Get the current level of the PowerPort.
int	getCurrentLimit() Get current limit of port.
java.lang.String	getName() Get name.
java.lang.String	getStatusMessage() Get status message.
java.lang.String	getStatusSummaryMessage() Get status summary message.
float	getTemperature() Get the temperature the PowerPort.
java.lang.String	getTerseStatus() Get a terse status message
float	getVoltageLevel() Get the voltage level of the PowerPort; not supported by NullPowerPort.
void	initialize() Initialize the port.
void	isolatePort() Isolate comms and power from port.
void	resetStatus() Reset status.
void	setCommsMode(CommsMode commsMode) Set communications mode (RS422,RS485,RS232) satisfies InstrumentPort interface
void	setCurrentLimit(int currentLimit) Set current limit on port.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final java.lang.String TYPE_NAME

See Also:

Constant Field Values

Constructor Detail

NullPowerPort

public NullPowerPort()

Method Detail

getName

public java.lang.String getName()

Get name.

Specified by:

getName in interface PowerPort

initialize

public void initialize()

Initialize the port.

Specified by:

initialize in interface PowerPort

setCurrentLimit

public void setCurrentLimit(int currentLimit)
                     throws NotSupportedException

Set current limit on port.

Specified by:

setCurrentLimit in interface PowerPort

Throws:

NotSupportedException

getCurrentLimit

public int getCurrentLimit()
                    throws NotSupportedException

Get current limit of port.

Specified by:

getCurrentLimit in interface PowerPort

Throws:

NotSupportedException

getVoltageLevel

public float getVoltageLevel()
                      throws NotSupportedException

Get the voltage level of the PowerPort; not supported by NullPowerPort.

Specified by:

getVoltageLevel in interface PowerPort

Throws:

NotSupportedException

getCurrentLevel

public float getCurrentLevel()
                      throws NotSupportedException

Get the current level of the PowerPort. not supported by NullPowerPort.

Specified by:

getCurrentLevel in interface PowerPort

Throws:

NotSupportedException

getTemperature

public float getTemperature()
                     throws NotSupportedException

Get the temperature the PowerPort. not supported by NullPowerPort.

Specified by:

getTemperature in interface PowerPort

Throws:

NotSupportedException

enableCommunications

public void enableCommunications()

Enable communications

Specified by:

enableCommunications in interface PowerPort

disableCommunications

public void disableCommunications()

Disable communications

Specified by:

disableCommunications in interface PowerPort

connectPower

public void connectPower()

Connect instrument to power.

Specified by:

connectPower in interface PowerPort

disconnectPower

public void disconnectPower()

Disconnect instrument from power.

Specified by:

disconnectPower in interface PowerPort

isolatePort

public void isolatePort()

Isolate comms and power from port.

Specified by:

isolatePort in interface PowerPort

getStatusMessage

public java.lang.String getStatusMessage()

Get status message.

Specified by:

getStatusMessage in interface PowerPort

getStatusSummaryMessage

public java.lang.String getStatusSummaryMessage()

Get status summary message.

Specified by:

getStatusSummaryMessage in interface PowerPort

resetStatus

public void resetStatus()

Reset status.

Specified by:

resetStatus in interface PowerPort

getTerseStatus

public java.lang.String getTerseStatus()

Get a terse status message

Specified by:

getTerseStatus in interface PowerPort

setCommsMode

public void setCommsMode(CommsMode commsMode)

Set communications mode (RS422,RS485,RS232) satisfies InstrumentPort interface

Specified by:

setCommsMode in interface PowerPort