Package io.zucchini.circuitsimtester.api

package io.zucchini.circuitsimtester.api

Contains wrapper classes which make internal CircuitSim APIs more friendly for testing, and provides annotations used to instruct CircuitSimExtension to lookup subcircuits, pins, or registers.

See Also:

• The README with examples
• Example tests
• CircuitSim source code

Class	Description
BaseMemory	Base class inherited by Ram and Rom.
BasePin	Wraps a CircuitSim Pin component.
Button	Allows pretending to push a button placed in a subcircuit.
Clock	Allows pretending to tick a Clock component placed in a subcircuit.
InputPin	Wraps a CircuitSim input Pin component and provides a convenience method for setting its value.
MockPulser	Similar to MockRegister but much simpler: manipulates an InputPin which replaced a clock or button and is used to send "pulses" into the circuit.
MockRegister	Represents a "ghost" register: a register component replaced with Pin components for easier testing.
OutputPin	Wraps a CircuitSim output Pin component and provides a convenience method for setting its value.
Ram	Wraps a CircuitSim RAM component.
Register	Wraps a CircuitSim Register component.
Restrictor	Validates a subcircuit by checking for issues such as banned components.
Rom	Wraps a CircuitSim ROM component.
Subcircuit	Represents and wraps the subcircuit to test.
Subcircuit.MemoryType	Please see Subcircuit.lookupMemory(String,int,boolean,MemoryType) for details on this enum.
Subcircuit.PulserType	Please see Subcircuit.mockPulser(String,boolean,PulserType) for details on this enum.
SubcircuitComponent	Instructs CircuitSimExtension to find and inject a CircuitSim component into the annotated field in a test class.
SubcircuitComponent.Type	Please see SubcircuitComponent.type() for details on this enum.
SubcircuitTest	Marks this JUnit test class as testing a subcircuit with the provided .sim file path and subcircuit name.