dioscuri.interfaces
Interface Module

All Known Subinterfaces:

Addressable, Updateable

All Known Implementing Classes:

AbstractModule, ATA, BIOS, Clock, CPU, DeviceDummy, DMA, DMAController, DynamicAllocationMemory, FDC, Keyboard, Memory, ModuleATA, ModuleBIOS, ModuleClock, ModuleCPU, ModuleDMA, ModuleFDC, ModuleKeyboard, ModuleMemory, ModuleMotherboard, ModuleMouse, ModuleParallelPort, ModulePIC, ModulePIT, ModuleRTC, ModuleScreen, ModuleSerialPort, ModuleVideo, Motherboard, Mouse, ParallelPort, PCI, PIC, PIT, Processor, RTC, Screen, SerialPort, Video

public interface Module

Nested Class Summary

static class

Module.Type The Type of a Module.

Method Summary

Module	getConnection(Module.Type type) Returns the Module of a certain Type connected to this Module.
java.util.Map<Module.Type,Module>	getConnections() Returns all connected, or supposedly connected, Modules of this Module.
boolean	getDebugMode() Returns the state of debug mode
java.lang.String	getDump() Return a dump of module status
Module.Type[]	getExpectedConnections() Get all Module.Type's this AbstractModule is supposed to be connected to.
Module.Type	getType() Returns the Type of this Module.
boolean	isConnected() Checks if this module is connected to operate normally
boolean	reset() Reset all parameters of module.
boolean	setConnection(Module module) Connect both Modules 'this' and 'module' to each other.
void	setDebugMode(boolean status) Set toggle to define if this module is in debug mode or not
void	start() Starts the module to become active.
void	stop() Stops the module from being active.

Method Detail

getConnection

Module getConnection(Module.Type type)

Returns the Module of a certain Type connected to this Module.

Parameters:

type - the Type of the Module to be fetched.

Returns:

the Module of a certain Type connected to this Module.

getConnections

java.util.Map<Module.Type,Module> getConnections()

Returns all connected, or supposedly connected, Modules of this Module.

Returns:

all connected, or supposedly connected, Modules of this Module.

getDebugMode

boolean getDebugMode()

Returns the state of debug mode

Returns:

true if this module is in debug mode, false otherwise

getDump

java.lang.String getDump()

Return a dump of module status

Returns:

string containing a dump of this module

getExpectedConnections

Module.Type[] getExpectedConnections()

Get all Module.Type's this AbstractModule is supposed to be connected to.

Returns:

an array of Module.Type's this AbstractModule is supposed to be connected to.

getType

Module.Type getType()

Returns the Type of this Module.

Returns:

the Type of this Module.

isConnected

boolean isConnected()

Checks if this module is connected to operate normally

Returns:

true if this module is connected successfully, false otherwise

reset

boolean reset()

Reset all parameters of module.

Returns:

true iff the AbstractModule was reset properly.

setConnection

boolean setConnection(Module module)

Connect both Modules 'this' and 'module' to each other.

Parameters:

module - the other AbstractModule.

Returns:

true iff both Modules 'this' and 'module' are properly connected to each other.

setDebugMode

void setDebugMode(boolean status)

Set toggle to define if this module is in debug mode or not

Parameters:

status - the new debug mode for this AbstractModule.

start

void start()

Starts the module to become active.

stop

void stop()

Stops the module from being active.