Package edu.gatech.cs2110.circuitsim.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 Summary

Class	Description
BasePin	Wraps a CircuitSim Pin component.
InputPin	Wraps a CircuitSim input Pin component and provides a convenience method for setting its value.
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.
Restrictor	Validates a subcircuit by checking for issues such as banned components.
Subcircuit	Represents and wraps the subcircuit to test.

Annotation Types Summary

Annotation Type	Description
SubcircuitPin	Instructs CircuitSimExtension to find and inject the Pin component into an InputPin or OutputPin field in a test class.
SubcircuitRegister	Instructs CircuitSimExtension to find and inject a MockRegister for a Register component into a MockRegister field in a test class.
SubcircuitTest	Marks this JUnit test class as testing a subcircuit with the provided .sim file path and subcircuit name.