edu.gvsu.dlunit

Class ISimulator

java.lang.Object

edu.gvsu.dlunit.ISimulator

public abstract class ISimulator
extends java.lang.Object

Interface to various digital logic simulators.

Author:

Zachary Kurmas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ISimulator.Extension Describes how a BitSit should be extended when being set on a larger input pin.

Constructor Summary

Constructors

Constructor and Description
ISimulator()

Method Summary

Modifier and Type	Method and Description
abstract int	getMemoryWidth(java.lang.String name) return the width of the memory (i.e., the memory's word size)
abstract int	getPinWidth(java.lang.String name) return the width of the pin
abstract int	getRegisterWidth(java.lang.String name) return the width of the register
abstract void	load(java.io.File file) Load a circuit from a file
void	load(java.lang.String filename) Load a circuit from a file
abstract java.util.BitSet[]	readMemoryBitSets(java.lang.String name, long address, int length) Get the values in memory as BitSets.
long[]	readMemorySigned(java.lang.String name, long address, int length) Get the values in the memory as signed long integers
long[]	readMemoryUnsigned(java.lang.String name, long address, int length) Get the values in memory as unsigned long integers
boolean	readPin(java.lang.String name) Get the value on a one-bit pin
abstract java.util.BitSet	readPinAsBitSet(java.lang.String name) Return the value on an output pin as a BitSet
long	readPinSigned(java.lang.String name) Get the value on the pin as a signed long integer
long	readPinUnsigned(java.lang.String name) Get the value on the pin as an unsigned long integer
boolean	readRegister(java.lang.String name) Get the value on a one-bit register
abstract java.util.BitSet	readRegisterBitSet(java.lang.String name)
long	readRegisterSigned(java.lang.String name) Get the value in the register as a signed long integer
long	readRegisterUnsigned(java.lang.String name) Get the value in the register as an unsigned long integer
abstract void	reset() Reset the simulator between tests
abstract void	run() Execute the simulator
abstract void	setMemorySigned(java.lang.String name, int beginningWordAddress, int[] values) Sets memory
abstract void	setMemoryUnsigned(java.lang.String name, int beginningWordAddress, int[] values) Sets memory using unsigned (positive) values only
abstract void	setPin(java.lang.String name, java.util.BitSet value, int size, ISimulator.Extension ext) Set the input pin name with a given set of bits.
void	setPin(java.lang.String name, boolean value) Set a single input pin name with a given value.
void	setPinSigned(java.lang.String name, long value) Set the specified input pin to value.
void	setPinUnsigned(java.lang.String name, long value) Set the specified input pin to value.
abstract void	setRegister(java.lang.String name, java.util.BitSet value, int size, ISimulator.Extension ext) Set the input register name with a given set of bits.
void	setRegister(java.lang.String name, boolean value) Set a one-bit register name with a given value.
void	setRegisterSigned(java.lang.String name, long value) Set the specified input register to value.
void	setRegisterUnsigned(java.lang.String name, long value) Set the specified register to value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ISimulator

public ISimulator()

Method Detail

getPinWidth

public abstract int getPinWidth(java.lang.String name)
                         throws NoSuchElementException,
                                InvalidElementException

return the width of the pin

Parameters:

name - the name of the pin

Returns:

the width of the pin

Throws:

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

InvalidElementException - if name is not an input pin

setPin

public abstract void setPin(java.lang.String name,
                            java.util.BitSet value,
                            int size,
                            ISimulator.Extension ext)
                     throws NoSuchElementException,
                            InvalidElementException,
                            InvalidWidthException

Set the input pin name with a given set of bits.

Parameters:

name - the name of the pin to be set

value - the set of values to place on each individual pin in the set

size - the number of bits to set.

ext - whether zero-extend or sign-extend the value if the pin is wider than size.

Throws:

NoSuchElementException - if an input pin named name can't be found

InvalidElementException - if name is not an input pin

InvalidWidthException - if the pin does not have width 1

setPin

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

Set a single input pin name with a given value.

Parameters:

name - the name of the pin to be set

value - the binary value to place on the pin

Throws:

NoSuchElementException - if an input pin named name can't be found

InvalidElementException - if name is not an input pin

InvalidWidthException - if the pin does not have width 1

setPinSigned

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

Set the specified input pin to value.

Parameters:

name - the name of the pin to set

value - the value to set the pin to.

Throws:

NoSuchElementException - if an input pin named name can't be found

InvalidElementException - if name is not an input pin

InvalidWidthException - if the given value is too big for the width of the pin

setPinUnsigned

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

Set the specified input pin to value.

Parameters:

name - the name of the pin to set

value - the value to set the pin to.

Throws:

NoSuchElementException - if an input pin named name can't be found

InvalidElementException - if name is not an input pin

InvalidWidthException - if the given value is too big for the width of the pin

IllegalValueException - if value is negative

readPinAsBitSet

public abstract java.util.BitSet readPinAsBitSet(java.lang.String name)
                                          throws NoSuchElementException,
                                                 InvalidElementException

Return the value on an output pin as a BitSet

Parameters:

name - the pin

Returns:

the value on the pin as a BitSet

Throws:

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

InvalidElementException - if name is not the correct type of element

readPin

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

Get the value on a one-bit pin

Parameters:

name - the pin name

Returns:

the value on the pin

Throws:

NoSuchElementException - an output pin named name can't be found

InvalidElementException - if name is not the correct type of element

InvalidWidthException

readPinSigned

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

Get the value on the pin as a signed long integer

Parameters:

name - the pin name

Returns:

the value on the pin as a signed integer

Throws:

NoSuchElementException - if an output pin named name can't be found

InvalidElementException - if name is not the correct type of element

readPinUnsigned

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

Get the value on the pin as an unsigned long integer

Parameters:

name - the pin name

Returns:

the value on the pin as an unsigned integer

Throws:

NoSuchElementException - if an output pin named name can't be found

InvalidElementException - if name is not the correct type of element

getRegisterWidth

public abstract int getRegisterWidth(java.lang.String name)
                              throws NoSuchElementException,
                                     InvalidElementException

return the width of the register

Parameters:

name - the name of the register

Returns:

the width of the register

Throws:

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

InvalidElementException - if name is not the correct type of element

setRegister

public abstract void setRegister(java.lang.String name,
                                 java.util.BitSet value,
                                 int size,
                                 ISimulator.Extension ext)
                          throws NoSuchElementException,
                                 InvalidElementException,
                                 InvalidWidthException

Set the input register name with a given set of bits.

Parameters:

name - the name of the register to be set

value - the set of values to place on each individual bit in the register

size - the number of bits to set.

ext - whether zero-extend or sign-extend the value if the register is wider than size.

Throws:

NoSuchElementException - if an input register named name can't be found

InvalidElementException - if name is not the correct type of element

InvalidWidthException - if the register does not have width 1

setRegister

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

Set a one-bit register name with a given value.

Parameters:

name - the name of the register to be set

value - the binary value to place in the register

Throws:

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

InvalidElementException - if name is not the correct type of element

InvalidWidthException - if the register does not have width 1

setRegisterSigned

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

Set the specified input register to value.

Parameters:

name - the name of the register to set

value - the value to place in the register

Throws:

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

InvalidElementException - if name is not the correct type of element

InvalidWidthException - if the given value is too big for the width of the register

setRegisterUnsigned

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

Set the specified register to value.

Parameters:

name - the name of the register to set

value - the value place in the register

Throws:

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

InvalidElementException - if name is not the correct type of element

InvalidWidthException - if the given value is too big for the width of the register

IllegalValueException - if value is negative

readRegisterBitSet

public abstract java.util.BitSet readRegisterBitSet(java.lang.String name)
                                             throws NoSuchElementException,
                                                    InvalidElementException

Throws:

NoSuchElementException

InvalidElementException

readRegister

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

Get the value on a one-bit register

Parameters:

name - the register name

Returns:

the value in the register

Throws:

NoSuchElementException - a register named name can't be found

InvalidElementException - if name is not the correct type of element

InvalidWidthException - if name is not one bit wide

readRegisterSigned

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

Get the value in the register as a signed long integer

Parameters:

name - the register name

Returns:

the value in the register as a signed integer

Throws:

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

InvalidElementException - if name is not the correct type of element

readRegisterUnsigned

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

Get the value in the register as an unsigned long integer

Parameters:

name - the register name

Returns:

the value in the register as an unsigned integer

Throws:

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

InvalidElementException - if name is not the correct type of element

setMemorySigned

public abstract 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

setMemoryUnsigned

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

Sets memory using unsigned (positive) values only

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

getMemoryWidth

public abstract int getMemoryWidth(java.lang.String name)
                            throws NoSuchElementException,
                                   InvalidElementException

return the width of the memory (i.e., the memory's word size)

Parameters:

name - the name of the memory

Returns:

the width of the memory (i.e., its word size)

Throws:

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

InvalidElementException - if name is not the correct type of element

readMemorySigned

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

Get the values in the memory as signed long integers

Parameters:

name - the memory name

address - the first word address to retreive

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

readMemoryUnsigned

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

Get the values in memory as unsigned long integers

Parameters:

name - the memory name

address - the word address

length - the number of words to read

Returns:

the value in the memory as an unsigned integer

Throws:

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

InvalidElementException - if name is not the correct type of element

readMemoryBitSets

public abstract java.util.BitSet[] readMemoryBitSets(java.lang.String name,
                                                     long address,
                                                     int length)
                                              throws NoSuchElementException,
                                                     InvalidElementException

Get the values in memory as BitSets.

Parameters:

name - the memory name

address - the word address

length - the number of words to read

Returns:

the values in memory as BitSets

Throws:

NoSuchElementException - if no memory named name is found

InvalidElementException - if name is not a memory

load

public abstract void load(java.io.File file)
                   throws Utilities.UnreadableFileException,
                          Utilities.InvalidCircuitException

Load a circuit from a file

Parameters:

file - the file containing the circuit

Throws:

Utilities.UnreadableFileException - if the file cannot be read (e.g., as a result of the permissions)

Utilities.InvalidCircuitException - if the simulator cannot parse the file.

load

public void load(java.lang.String filename)
          throws Utilities.UnreadableFileException,
                 Utilities.InvalidCircuitException

Load a circuit from a file

Parameters:

filename - the name of the file containing the circuit

Throws:

Utilities.UnreadableFileException - if the file cannot be read (e.g., as a result of the permissions)

Utilities.InvalidCircuitException - if the simulator cannot parse the file.

run

public abstract void run()

Execute the simulator

reset

public abstract void reset()

Reset the simulator between tests