org.mbari.siam.core
Interface Puck

All Known Implementing Classes:

NullPuck

public interface Puck

Method Summary

java.io.InputStream	getInputStream() get an InputStream to the puck
void	initialize() initialize the puck
void	managePowerSleep(int comms_policy, int inst_policy) perform any necessary puck operations before entering powering down
void	managePowerWake(int comms_policy, int inst_policy) perform any necessary puck operations on wake-up
void	resume() call when device service is resumed
void	setSensorMode() switch the puck to sensor mode
void	suspend() call when device service is suspended

Method Detail

initialize

void initialize()
                throws InitializeException

initialize the puck

Throws:

InitializeException

setSensorMode

void setSensorMode()
                   throws java.io.IOException

switch the puck to sensor mode

Throws:

java.io.IOException

managePowerWake

void managePowerWake(int comms_policy,
                     int inst_policy)
                     throws java.io.IOException

perform any necessary puck operations on wake-up

Throws:

java.io.IOException

managePowerSleep

void managePowerSleep(int comms_policy,
                      int inst_policy)
                      throws java.io.IOException

perform any necessary puck operations before entering powering down

Throws:

java.io.IOException

resume

void resume()

call when device service is resumed

suspend

void suspend()

call when device service is suspended

getInputStream

java.io.InputStream getInputStream()
                                   throws java.io.IOException

get an InputStream to the puck

Throws:

java.io.IOException