Circuit

java.lang.Object
- Circuit

All Implemented Interfaces:

Logic
```
public class Circuit
extends java.lang.Object
implements Logic
```
Circuit class implements Logic since each circuti will follow the Logics by combining together the logic of the gates. So we will build logic circuits by reading the contect in files and return some out that will follow the logic.

Constructor Summary

Constructors
Constructor and Description
`Circuit(java.lang.String circuitName)` This constructor will construct a Circuit by given the name of the circuit To do this I will follow this steps *1.initialize all fields, first thing (including empty lists).
`Circuit(java.lang.String circuitName, java.util.List<Logic> components, java.util.List<Contact> inputs, java.util.List<Contact> outputs, java.util.List<Wire> innerWires, java.util.List<java.lang.String> importables)` Circuit constructor, construct the design of contact class

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`feed(java.util.List<Signal> inSigs)` feed method feeds these signal values to the inputs contacts.
`void`	`feed(java.lang.String s)` feed method feeds these String into inputs list
`Wire`	`findWire(java.lang.String name)` findWire finds if this wire exist on innerWire and return the wire if not return null
`java.util.Scanner`	`getCircuitScanner(java.lang.String circuitName)` getCircuitScanner will create a scanner that will read file of format .txr on samples folder.
`java.util.List<Logic>`	`getComponents()` getComponents
`java.util.List<java.lang.String>`	`getImportables()` getImportables
`java.util.List<Wire>`	`getInnerWires()` getInnerWires
`java.util.List<Contact>`	`getInputs()` getInputs
`java.lang.String`	`getName()` getName
`java.util.List<Contact>`	`getOutputs()` getOutputs
`void`	`hookUp(java.util.List<Wire> inWires, java.util.List<Wire> outWires)` hookUp will connect togother the wire from outside to the wire inside the circuit inWires will be set on inputs contact in Wire and outWire will be set on the outputs contact out Wire.
`static java.lang.String`	`indent(java.lang.String s)` indent method add indent to the string of lines
`java.util.List<Signal>`	`inspect(java.util.List<Signal> inputs)` A combination of feeding, propagating, and reading.
`java.lang.String`	`inspect(java.lang.String inputs)` We will return the String of the inputs that we did in previous method.
`void`	`parseComponentLine(java.lang.String line)` parseComponentLine reads the line and check if it has sub-circuit in it if not has a gate.
`void`	`parseContactsLine(java.lang.String line)` parseContactsLine reads each line of string and creates new wires and store them at innerWires list and for each one, create a Contact and appropriately add it to either inputs or outputs.
`void`	`parseImportLine(java.lang.String line)` parseImportLine reads a line of string that have Import word on it and stores each of other tokens in list importables but not the import word.
`boolean`	`propagate()` propagate fully update all outputs of all components in this circuit so that all signal values are stable.
`java.util.List<Signal>`	`read()` reads the signal values from the outputs contact, and create a list of singls of outputs
`void`	`setComponents(java.util.List<Logic> components)` setComponents sets the components to parameter value
`void`	`setImportables(java.util.List<java.lang.String> importables)` setImportables sets the importables to parameter value
`void`	`setInnerWires(java.util.List<Wire> innerWires)` setInnerWires sets the innerWires to parameter value
`void`	`setInputs(java.util.List<Contact> inputs)` setInputs sets the inputs to parameter value
`void`	`setName(java.lang.String name)` setName sets the name to parameter value
`void`	`setOutputs(java.util.List<Contact> outputs)` setOutputs sets the outputs to parameter value
`java.lang.String`	`toString()` toString return the repersantion of the Circuit in strings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Circuit
```
public Circuit(java.lang.String circuitName,
               java.util.List<Logic> components,
               java.util.List<Contact> inputs,
               java.util.List<Contact> outputs,
               java.util.List<Wire> innerWires,
               java.util.List<java.lang.String> importables)
```
    Circuit constructor, construct the design of contact class
    
    Parameters:
    
    circuitName - the name of circuit.
    
    components - The list of logical blocks that are wired together in this circuit.
    
    inputs - the list of contacts that are all inputs.
    
    outputs - the list of contacts that are all outputs.
    
    innerWires - a list were we store all are inner wires.
    
    importables - a list of names that we will import sub-circuits.
  - Circuit
```
public Circuit(java.lang.String circuitName)
        throws java.io.IOException
```
    This constructor will construct a Circuit by given the name of the circuit To do this I will follow this steps *1.initialize all fields, first thing (including empty lists). *2.get a scanner via getCircuitScanner, to read through the file. *3 call parseImportLine if appropriate, to find and add items to the importables list. *4 call parseContactsLine, to find and add all Contact values to inputs and outputs. *5 repeatedly call parseComponentLine as necessary, to successfully create the particular type of gate or sub-circuit, hook it up to the overall circuit as needed, and add it to the components list. (This list can contain gates and circuits, as they are all implementors of Logic).
    
    Throws:
    
    java.io.IOException
- Method Detail
  - getCircuitScanner
```
public java.util.Scanner getCircuitScanner(java.lang.String circuitName)
                                    throws java.io.FileNotFoundException
```
    getCircuitScanner will create a scanner that will read file of format .txr on samples folder.
    
    Throws:
    
    java.io.FileNotFoundException
  - parseImportLine
```
public void parseImportLine(java.lang.String line)
```
    parseImportLine reads a line of string that have Import word on it and stores each of other tokens in list importables but not the import word.
  - parseContactsLine
```
public void parseContactsLine(java.lang.String line)
```
    parseContactsLine reads each line of string and creates new wires and store them at innerWires list and for each one, create a Contact and appropriately add it to either inputs or outputs.
  - findWire
```
public Wire findWire(java.lang.String name)
```
    findWire finds if this wire exist on innerWire and return the wire if not return null
    
    Returns:
    
    null or the wire if it exist.
  - hookUp
```
public void hookUp(java.util.List<Wire> inWires,
                   java.util.List<Wire> outWires)
```
    hookUp will connect togother the wire from outside to the wire inside the circuit inWires will be set on inputs contact in Wire and outWire will be set on the outputs contact out Wire.
    
    Throws:
    
    ExceptionLogicParameters - if the numbere of wire doesnt match.
  - parseComponentLine
```
public void parseComponentLine(java.lang.String line)
                        throws java.io.IOException
```
    parseComponentLine reads the line and check if it has sub-circuit in it if not has a gate. if sub-circuit it will create subcircuit with that name and hookup the wire and add this to component list. if it is gate will create a gate and will add this gate to component list of logics
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    toString return the repersantion of the Circuit in strings. Indent each line if we a subcircuit and if we have gates. In order to make it easy to see where the gates belong. So each indent will be the level where that part of circuit belong.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string of the circuit
  - indent
```
public static java.lang.String indent(java.lang.String s)
```
    indent method add indent to the string of lines
    
    Returns:
    
    return a string that has added exactly two spaces at the front of each line
  - feed
```
public void feed(java.util.List<Signal> inSigs)
```
    feed method feeds these signal values to the inputs contacts. Will get input contact, will get in wire of the contact and will set signal from the list of inSigs to that contact in wire.
    
    Specified by:
    
    feed in interface Logic
    
    Parameters:
    
    inSigs - are the list that will assing the wire
    
    Throws:
    
    ExceptionLogicParameters - value if the inSigs size is not equal to inputs size.
  - feed
```
public void feed(java.lang.String s)
```
    feed method feeds these String into inputs list
    
    Specified by:
    
    feed in interface Logic
    
    Parameters:
    
    s - is string of singlas to put into inputs list overloads the feed since just the parameter change same name for method.
  - read
```
public java.util.List<Signal> read()
```
    reads the signal values from the outputs contact, and create a list of singls of outputs
    
    Specified by:
    
    read in interface Logic
    
    Returns:
    
    it as a single value in a List.
  - propagate
```
public boolean propagate()
```
    propagate fully update all outputs of all components in this circuit so that all signal values are stable. three steps are neccesary. 1) Pass input signal from input Contact into output signal from input Contact 2) propagate components 3) Pass input signal from output Contact into output signal from output Contact
    
    Specified by:
    
    propagate in interface Logic
    
    Returns:
    
    boolean value
  - inspect
```
public java.util.List<Signal> inspect(java.util.List<Signal> inputs)
```
    A combination of feeding, propagating, and reading. Calls feed() propaget() and read ().
    
    Specified by:
    
    inspect in interface Logic
    
    Parameters:
    
    inputs - is the list of inputs
    
    Returns:
    
    the List of signals from the read()
  - inspect
```
public java.lang.String inspect(java.lang.String inputs)
```
    We will return the String of the inputs that we did in previous method.
    
    Specified by:
    
    inspect in interface Logic
    
    Parameters:
    
    inputs - is the list of inputs
    
    Returns:
    
    the String of signals that are output signals
  - setComponents
```
public void setComponents(java.util.List<Logic> components)
```
    setComponents sets the components to parameter value
    
    Parameters:
    
    components - the value to set the components
  - getComponents
```
public java.util.List<Logic> getComponents()
```
    getComponents
    
    Returns:
    
    the components of this circuit
  - setInputs
```
public void setInputs(java.util.List<Contact> inputs)
```
    setInputs sets the inputs to parameter value
    
    Parameters:
    
    inputs - the value to set the inputs
  - getInputs
```
public java.util.List<Contact> getInputs()
```
    getInputs
    
    Returns:
    
    the inputs contacs of this circuit
  - setOutputs
```
public void setOutputs(java.util.List<Contact> outputs)
```
    setOutputs sets the outputs to parameter value
    
    Parameters:
    
    outputs - the value to set the outputs
  - getOutputs
```
public java.util.List<Contact> getOutputs()
```
    getOutputs
    
    Returns:
    
    the outputs contacs of this circuit
  - setInnerWires
```
public void setInnerWires(java.util.List<Wire> innerWires)
```
    setInnerWires sets the innerWires to parameter value
    
    Parameters:
    
    innerWires - the value to set the innerWires
  - getInnerWires
```
public java.util.List<Wire> getInnerWires()
```
    getInnerWires
    
    Returns:
    
    the innerWires of this circuit
  - setImportables
```
public void setImportables(java.util.List<java.lang.String> importables)
```
    setImportables sets the importables to parameter value
    
    Parameters:
    
    importables - the value to set the importables
  - getImportables
```
public java.util.List<java.lang.String> getImportables()
```
    getImportables
    
    Returns:
    
    the importables of this circuit
  - setName
```
public void setName(java.lang.String name)
```
    setName sets the name to parameter value
    
    Parameters:
    
    name - the value to set the name
  - getName
```
public java.lang.String getName()
```
    getName
    
    Returns:
    
    the name of this circuit

Class Circuit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Circuit

Circuit

Method Detail

getCircuitScanner

parseImportLine

parseContactsLine

findWire

hookUp

parseComponentLine

toString

indent

feed

feed

read

propagate

inspect

inspect

setComponents

getComponents

setInputs

getInputs

setOutputs

getOutputs

setInnerWires

getInnerWires

setImportables

getImportables

setName

getName