byucc.jhdl.base
Class Port

java.lang.Object
  byucc.jhdl.base.PortInfo
      byucc.jhdl.base.Port

All Implemented Interfaces:

BooleanFlags, CellInterface

public class Port

extends byucc.jhdl.base.PortInfo

implements CellInterface

This class represents a port within a cell's interface. Public access for port creation comes via in(), out() and related methods in Cell. If a port has generic width, the parameters that determine the width must be Cell.BOOLEAN.

Author:

Brad L. Hutchings

Field Summary

static java.lang.String	IN_STRING Constants related to the old style of cell interfacing
static java.lang.String	INOUT_STRING Constants related to the old style of cell interfacing
static int	NOT_EVALUATED A constant for an unevaluated port width
static java.lang.String	OUT_STRING Constants related to the old style of cell interfacing

Fields inherited from interface byucc.jhdl.base.BooleanFlags

ANTECEDANT_IS_BEHAVIORALLY_MODELED, ASYNC_PORT, ASYNCHRONOUS_RESOLVED, ATOMICALLY_PLACEABLE, ATOMICALLY_UNMAPPABLE, BEHAVIORALLY_MODELED_BRANCH, CLK_PORT, CLOCK_METHOD_IMPLEMENTED_BY_USER, CLOCK_METHOD_IS_DISABLED, CLOCKABLE_IS_SCHEDULED, DANGLING_IS_OK, DELETE_MARK, FATAL_BUILD_ERROR_OCCURED, HAS_BEEN_TRACED, HAS_USER_SPECIFIED_NAME, HWUPDATE, IMPLICIT_PORT, IN_CLK_PORT, IN_PORT, INOUT_PORT, IO_TYPE_FLAGS, IS_BEHAVIORALLY_MODELED, IS_ON_BUILD_STACK, IS_ON_PROP_LIST, IS_PLACED, METHODS_IMPLEMENTED_BY_USER, NETLISTABLE, ORIG_WIRE_IS_ATOMIC, OUT_PORT, PLACEMENT_IS_LOCKED, PROPAGATE_METHOD_IMPLEMENTED_BY_USER, PROPAGATE_METHOD_IS_DISABLED, RECURSION_FLAG, RESET_METHOD_IMPLEMENTED_BY_USER, SIMULATEABLE, SOURCELESS_IS_OK, SYNC_PORT, VISIBLE

Method Summary

int	getIoType() Deprecated. use PortInfo.getIOType()
int	getIOType() Returns the IO type
java.lang.String	getName() Returns the port name
java.lang.String	getStringWidth() Returns the string width of the port
int	getWidth() Returns the integer port width (may be PortInfo.NOT_EVALUATED
boolean	isAsyncPort() Returns whether the port in set as an AsyncPort
boolean	isClkPort() Returns whether the port is a clock port
boolean	isImplicitPort() Returns whether the port is implicit
boolean	isInOutPort() Returns whether the port is an inout port
boolean	isInPort() Returns whether the port is an in or inout port
boolean	isOutPort() Returns whether the port is an out or inout port
boolean	isSyncPort() Returns whether the port in set as a SyncPort
void	setAsyncPort()
void	setSyncPort()
java.lang.String	toString() Formats the port for display

Methods inherited from class java.lang.Object

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

Methods inherited from interface byucc.jhdl.base.CellInterface

getName

Field Detail

NOT_EVALUATED

public static final int NOT_EVALUATED

A constant for an unevaluated port width

See Also:

Constant Field Values

IN_STRING

public static final java.lang.String IN_STRING

Constants related to the old style of cell interfacing

See Also:

Constant Field Values

OUT_STRING

public static final java.lang.String OUT_STRING

Constants related to the old style of cell interfacing

See Also:

Constant Field Values

INOUT_STRING

public static final java.lang.String INOUT_STRING

Constants related to the old style of cell interfacing

See Also:

Constant Field Values

Method Detail

getStringWidth

public java.lang.String getStringWidth()

Returns the string width of the port

Returns:

the String representation width of the Port.

getIoType

public int getIoType()

Deprecated. use PortInfo.getIOType()

Returns the port IO type

Returns:

the io type of the Port.

getName

public final java.lang.String getName()

Returns the port name

Returns:

the name

getWidth

public final int getWidth()

Returns the integer port width (may be PortInfo.NOT_EVALUATED

Returns:

the width

getIOType

public final int getIOType()

Returns the IO type

Returns:

the IO type of the port

isImplicitPort

public final boolean isImplicitPort()

Returns whether the port is implicit

Returns:

true if the port is implicit

isClkPort

public final boolean isClkPort()

Returns whether the port is a clock port

Returns:

true if the port is a clock

isInPort

public final boolean isInPort()

Returns whether the port is an in or inout port

Returns:

true if the port is in or inout

isOutPort

public final boolean isOutPort()

Returns whether the port is an out or inout port

Returns:

true if the port is out or inout

isInOutPort

public final boolean isInOutPort()

Returns whether the port is an inout port

Returns:

true if the port is an inout port

isAsyncPort

public final boolean isAsyncPort()

Returns whether the port in set as an AsyncPort

Returns:

true if the port is an AsyncPort

setAsyncPort

public final void setAsyncPort()

isSyncPort

public final boolean isSyncPort()

Returns whether the port in set as a SyncPort

Returns:

true if the port is an SyncPort

setSyncPort

public final void setSyncPort()

toString

public java.lang.String toString()

Formats the port for display

Returns:

a string describing the port