edu.gvsu.dlunit

Class DLUnit

java.lang.Object

edu.gvsu.dlunit.DLUnit

public class DLUnit
extends java.lang.Object

The public DLUnit interface: Use these methods to drive the underlying simulator and query its final state.

Author:

Joseph Bentley, Zachary Kurmas

Method Summary

Modifier and Type	Method and Description
static long	readMemorySigned(java.lang.String name, long address) Get the value in the memory as a signed long integer
static long[]	readMemorySigned(java.lang.String name, long start, int length) Get the values in the memory as signed long integers
static long	readMemoryUnsigned(java.lang.String name, long address) Get the value in the memory as a signed long integer
static long[]	readMemoryUnsigned(java.lang.String name, long start, int length) Get the values in the memory as unsigned long integers
static boolean	readPin(java.lang.String name) Get the value of a single output pin
static long	readPinSigned(java.lang.String name) Get the value on pin name as a signed integer (i.e., interpret the most significant bit as a sign bit).
static long	readPinUnsigned(java.lang.String name) Get the value on pin name as an unsigned integer.
static boolean	readRegister(java.lang.String name) Get the value of a one-bit register
static long	readRegisterSigned(java.lang.String name) Get the value in register name as a signed integer (i.e., interpret the most significant bit as a sign bit).
static long	readRegisterUnsigned(java.lang.String name) Get the value in register name as an unsigned integer.
static void	reset() Reset the simulator.
static void	run() Execute the simulator
static void	setMemorySigned(java.lang.String name, int beginningWordAddress, int value) Sets memory
static void	setMemorySigned(java.lang.String name, int beginningWordAddress, int[] values) Sets memory
static void	setMemoryUnsigned(java.lang.String name, int beginningWordAddress, int value) Sets memory as unsigned (positive) integers
static void	setMemoryUnsigned(java.lang.String name, int beginningWordAddress, int[] values) Sets memory as unsigned (positive) integers
static void	setPin(java.lang.String name, boolean value) Set a one-bit input pin.
static void	setPinSigned(java.lang.String name, long value) Set an input bus (multiple pins bundled together as a single unit).
static void	setPinUnsigned(java.lang.String name, long value) Set an input bus (multiple pins bundled together as a single unit).
static void	setRegister(java.lang.String name, boolean value) Set a one-bit register.
static void	setRegisterSigned(java.lang.String name, long value) Set a register.
static void	setRegisterUnsigned(java.lang.String name, long value) Set a register.
static java.util.List<java.lang.String>	testParameters() Get the test parameters.

Methods inherited from class java.lang.Object

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

Method Detail

reset

public static void reset()

Reset the simulator. The main engine does this after every test. Users need only call this method by hand when running the simulator multiple times within a single JUnit test.

testParameters

public static java.util.List<java.lang.String> testParameters()

Get the test parameters. Specifically, return the list of values for the --parameter and --input options entered on the command line.

Returns:

an unmodifiable List of parameters for the test

setPin

public static void setPin(java.lang.String name,
                          boolean value)
                   throws NoSuchElementException,
                          InvalidElementException,
                          InvalidWidthException

Set a one-bit input pin. Cannot be used on multi-bit input pins (i.e., buses).

Parameters:

name - the name of the input pin

value - the value to be set (true or false).

Throws:

NoSuchElementException - If there is no input pin named name

InvalidElementException - If name is not an input pin

InvalidWidthException - If the input pin does not have width 1.

setPinSigned

public static void setPinSigned(java.lang.String name,
                                long value)
                         throws NoSuchElementException,
                                InvalidElementException,
                                InvalidWidthException

Set an input bus (multiple pins bundled together as a single unit). When using this method, the input pin must have enough room for a sign bit.

Parameters:

name - the name of the input pin

value - the value to be set

Throws:

NoSuchElementException - if there is no input pin named (key)

InvalidElementException - If name is not an input pin

InvalidWidthException - if the input pin is not wide enough (i.e., does not have enough bits) to represent value

setPinUnsigned

public static void setPinUnsigned(java.lang.String name,
                                  long value)
                           throws NoSuchElementException,
                                  InvalidElementException,
                                  InvalidWidthException,
                                  IllegalValueException

Set an input bus (multiple pins bundled together as a single unit).

Parameters:

name - the name of the input pin

value - the value to be set

Throws:

NoSuchElementException - if there is no input pin named (key)

InvalidElementException - If name is not an input pin

InvalidWidthException - if the input pin is not wide enough (i.e., does not have enough bits) to represent value

IllegalValueException - if value is negative

readPin

public static boolean readPin(java.lang.String name)
                       throws NoSuchElementException,
                              InvalidElementException,
                              InvalidWidthException

Get the value of a single output pin

Parameters:

name - the name of the output pin

Returns:

true if the pin is set, false otherwise

Throws:

NoSuchElementException - if there is no output pin named (name)

InvalidElementException - If name is not an output pin

InvalidWidthException - if name is not one bit wide.

readPinSigned

public static long readPinSigned(java.lang.String name)
                          throws NoSuchElementException,
                                 InvalidElementException

Get the value on pin name as a signed integer (i.e., interpret the most significant bit as a sign bit).

Parameters:

name - the name of the output pin

Returns:

the value on pin name as a signed integer

Throws:

NoSuchElementException - if there is no output pin named (name)

InvalidElementException - If name is not an output pin

readPinUnsigned

public static long readPinUnsigned(java.lang.String name)
                            throws NoSuchElementException,
                                   InvalidElementException

Get the value on pin name as an unsigned integer.

Parameters:

name - the name of the output pin

Returns:

the value on pin name as an unsigned integer

Throws:

NoSuchElementException - if there is no output pin named (name)

InvalidElementException - If name is not an output pin

setRegister

public static void setRegister(java.lang.String name,
                               boolean value)
                        throws NoSuchElementException,
                               InvalidElementException,
                               InvalidWidthException

Set a one-bit register. Cannot be used on multi-bit register.

Parameters:

name - the name of the register

value - the value to be set (true or false).

Throws:

NoSuchElementException - If there is no register named name

InvalidElementException - If name is not a register

InvalidWidthException - If the register does not have width 1.

setRegisterSigned

public static void setRegisterSigned(java.lang.String name,
                                     long value)
                              throws NoSuchElementException,
                                     InvalidElementException,
                                     InvalidWidthException

Set a register. When using this method, the register must have enough room for a sign bit.

Parameters:

name - the name of the register

value - the value to be set

Throws:

NoSuchElementException - if there is no register named (key)

InvalidElementException - If name is not a register

InvalidWidthException - if the register is not wide enough (i.e., does not have enough bits) to represent value

setRegisterUnsigned

public static void setRegisterUnsigned(java.lang.String name,
                                       long value)
                                throws NoSuchElementException,
                                       InvalidElementException,
                                       InvalidWidthException,
                                       IllegalValueException

Set a register.

Parameters:

name - the name of the register

value - the value to be set

Throws:

NoSuchElementException - if there is no register named (key)

InvalidElementException - If name is not a register

InvalidWidthException - if the register is not wide enough (i.e., does not have enough bits) to represent value

IllegalValueException - if value is negative

readRegister

public static boolean readRegister(java.lang.String name)
                            throws NoSuchElementException,
                                   InvalidElementException,
                                   InvalidWidthException

Get the value of a one-bit register

Parameters:

name - the name of the register

Returns:

true if the register, false otherwise

Throws:

NoSuchElementException - if there is no register named (name)

InvalidElementException - if name is not a register

InvalidWidthException - if name is not one bit wide

readRegisterSigned

public static long readRegisterSigned(java.lang.String name)
                               throws NoSuchElementException,
                                      InvalidElementException

Get the value in register name as a signed integer (i.e., interpret the most significant bit as a sign bit).

Parameters:

name - the name of the register

Returns:

the value on pin name as a signed integer

Throws:

NoSuchElementException - if there is no register named (name)

InvalidElementException - if name is not a register

readRegisterUnsigned

public static long readRegisterUnsigned(java.lang.String name)
                                 throws NoSuchElementException,
                                        InvalidElementException

Get the value in register name as an unsigned integer.

Parameters:

name - the name of the register

Returns:

the value in register name as an unsigned integer

Throws:

NoSuchElementException - if there is no register named (name)

InvalidElementException - if name is not a register

setMemorySigned

public static void setMemorySigned(java.lang.String name,
                                   int beginningWordAddress,
                                   int[] values)
                            throws NoSuchElementException,
                                   InvalidElementException

Sets memory

Parameters:

name - the name of the memory.

beginningWordAddress - word address of the first word to be set

values - an array of word values to be set. (The entire array will be set.)

Throws:

NoSuchElementException - If there is no memory named name

InvalidElementException - If name is not a memory

setMemorySigned

public static void setMemorySigned(java.lang.String name,
                                   int beginningWordAddress,
                                   int value)
                            throws NoSuchElementException,
                                   InvalidElementException

Sets memory

Parameters:

name - the name of the memory.

beginningWordAddress - word address of the first word to be set

value - the word value to be set

Throws:

NoSuchElementException - If there is no memory named name

InvalidElementException - If name is not a memory

setMemoryUnsigned

public static void setMemoryUnsigned(java.lang.String name,
                                     int beginningWordAddress,
                                     int[] values)
                              throws NoSuchElementException,
                                     InvalidElementException

Sets memory as unsigned (positive) integers

Parameters:

name - the name of the memory.

beginningWordAddress - word address of the first word to be set

values - an array of word values to be set. (The entire array will be set.)

Throws:

NoSuchElementException - If there is no memory named name

InvalidElementException - If name is not a memory

setMemoryUnsigned

public static void setMemoryUnsigned(java.lang.String name,
                                     int beginningWordAddress,
                                     int value)
                              throws NoSuchElementException,
                                     InvalidElementException

Sets memory as unsigned (positive) integers

Parameters:

name - the name of the memory.

beginningWordAddress - word address of the first word to be set

value - the value to be set

Throws:

NoSuchElementException - If there is no memory named name

InvalidElementException - If name is not a memory

readMemorySigned

public static long[] readMemorySigned(java.lang.String name,
                                      long start,
                                      int length)
                               throws NoSuchElementException,
                                      InvalidElementException

Get the values in the memory as signed long integers

Parameters:

name - the memory name

start - the first word address to retrieve

length - the number of word addresses to retrieve

Returns:

the values as signed integers

Throws:

NoSuchElementException - if a memory named name can't be found

InvalidElementException - if name is not the correct type of element

readMemorySigned

public static long readMemorySigned(java.lang.String name,
                                    long address)
                             throws NoSuchElementException,
                                    InvalidElementException

Get the value in the memory as a signed long integer

Parameters:

name - the memory name

address - the word address to retreive

Returns:

the value as a signed integer

Throws:

NoSuchElementException - if a memory named name can't be found

InvalidElementException - if name is not the correct type of element

readMemoryUnsigned

public static long[] readMemoryUnsigned(java.lang.String name,
                                        long start,
                                        int length)
                                 throws NoSuchElementException,
                                        InvalidElementException

Get the values in the memory as unsigned long integers

Parameters:

name - the memory name

start - the first word address to retrieve

length - the number of word addresses to retrieve

Returns:

the values as unsigned integers

Throws:

NoSuchElementException - if a memory named name can't be found

InvalidElementException - if name is not the correct type of element

readMemoryUnsigned

public static long readMemoryUnsigned(java.lang.String name,
                                      long address)
                               throws NoSuchElementException,
                                      InvalidElementException

Get the value in the memory as a signed long integer

Parameters:

name - the memory name

address - the word address to retrieve

Returns:

the value as an unsigned integer

Throws:

NoSuchElementException - if a memory named name can't be found

InvalidElementException - if name is not the correct type of element

run

public static void run()

Execute the simulator