byucc.jhdl.base
Class Connection

java.lang.Object
  byucc.jhdl.base.Connection

Direct Known Subclasses:

AtomicConnection, BusConnection, FlatConnection

public abstract class Connection

extends java.lang.Object

Used to store connection information that can be used by netlisting code. A connection ties a net to a port.

Author:

Brad L. Hutchings

Field Summary

protected Cell	cell The cell that is connected to
protected boolean	is_atomic_port Whether the port is atomic width
protected int	port_name_index The index of the port within the cell

Constructor Summary

protected

Connection(Cell cell, int port_name_index, boolean is_atomic_port) Construct a connection

Method Summary

abstract int	getAtomicIndex() Returns the index of the port within a multi-bit port
Cell	getCell() Returns the connected cell
java.lang.String	getCellFullName() Returns the connected port name
java.lang.String	getCellName() Returns the connected cell's name
abstract java.lang.String	getIndexString() Return a string describing the index of the connection within the port
java.lang.String	getPortName() Returns the connected port name
int	getPortNameIndex()
int	getPortWidth() Returns the connected port width
boolean	isAtomicPort() Returns true if the port is atomic
java.lang.String	toString() Returns string representing contents of Connection, useful in debugging

Methods inherited from class java.lang.Object

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

Field Detail

cell

protected Cell cell

The cell that is connected to

port_name_index

protected int port_name_index

The index of the port within the cell

is_atomic_port

protected boolean is_atomic_port

Whether the port is atomic width

Constructor Detail

Connection

protected Connection(Cell cell,
                     int port_name_index,
                     boolean is_atomic_port)

Construct a connection

Parameters:

cell - the cell it is connected to

port_name_index - the index of the port within that cell

is_atomic_port - whether the port is atomic

Throws:

BuildException - if an attempt is made to netlist before the circuit has been cleaned up. See Cell.verifyAndCleanup().

Method Detail

getCellName

public java.lang.String getCellName()

Returns the connected cell's name

Returns:

the cell name

getCellFullName

public java.lang.String getCellFullName()

Returns the connected port name

Returns:

the port name

getPortNameIndex

public int getPortNameIndex()

getPortName

public java.lang.String getPortName()

Returns the connected port name

Returns:

the port name

getPortWidth

public int getPortWidth()

Returns the connected port width

Returns:

the port width

getAtomicIndex

public abstract int getAtomicIndex()

Returns the index of the port within a multi-bit port

Returns:

the index of an atomic bit within the port

getIndexString

public abstract java.lang.String getIndexString()

Return a string describing the index of the connection within the port

Returns:

a string describing the index

isAtomicPort

public boolean isAtomicPort()

Returns true if the port is atomic

Returns:

true if is atomic

getCell

public Cell getCell()

Returns the connected cell

Returns:

the connected cell

toString

public java.lang.String toString()

Returns string representing contents of Connection, useful in debugging

Returns:

string of contents