osgi.enroute.iot.circuit.command

Class CircuitCommand

java.lang.Object

osgi.enroute.iot.circuit.command.CircuitCommand

public class CircuitCommand
extends java.lang.Object

Commands to work with a circuit

Constructor Summary

Constructors

Constructor and Description
CircuitCommand()

Method Summary

Modifier and Type	Method and Description
java.lang.String	circuit()
void	clock(java.lang.String name) Create a clock that reverses its output pin ever second.
WireDTO	connect(java.lang.String fromDevice, java.lang.String fromPin, java.lang.String toDevice, java.lang.String toPin) Connect 2 ICs from an input pin to an output pin
boolean	disconnect(int wireId) Disconnect a wire by its ide
void	gpo(java.lang.String name) Create an IC that sends any input to System.out.
ICDTO[]	ics() List the ICs
java.util.List<WireDTO>	wires() List the wires

Methods inherited from class java.lang.Object

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

Constructor Detail

CircuitCommand

public CircuitCommand()

Method Detail

circuit

public java.lang.String circuit()

wires

public java.util.List<WireDTO> wires()

List the wires

ics

public ICDTO[] ics()

List the ICs

connect

public WireDTO connect(java.lang.String fromDevice,
                       java.lang.String fromPin,
                       java.lang.String toDevice,
                       java.lang.String toPin)
                throws java.lang.Exception

Connect 2 ICs from an input pin to an output pin

Parameters:

fromDevice - The IC's id that is the source

fromPin - the source's pin

toDevice - the IC's id that is the destination

toPin - the destination's pin

Returns:

A description of the wire

Throws:

java.lang.Exception

disconnect

public boolean disconnect(int wireId)
                   throws java.lang.Exception

Disconnect a wire by its ide

Parameters:

wireId - the wire's id

Returns:

if the wire existed

Throws:

java.lang.Exception

gpo

public void gpo(java.lang.String name)

Create an IC that sends any input to System.out. The life cycle of this IC is depending on this component, so it is not persistent.

Parameters:

name - the name/id of this IC

clock

public void clock(java.lang.String name)

Create a clock that reverses its output pin ever second. The life cycle of this IC is depending on this component, so it is not persistent.

Parameters:

name - The name/id of this IC