J-Sim v1.2.1-p7 API

drcl.comp
Class Wire

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Wire
All Implemented Interfaces:
java.lang.Cloneable, ObjectDuplicable, java.io.Serializable

public class Wire
extends DrclObj

See Also:
Serialized Form

Constructor Summary
Wire()
           
 
Method Summary
 boolean anyPortExcept(Port excluded_)
          Returns true if there exists a port, other than excluded_, which is connected to this wire.
 void attach(Port p_)
          Attaches the port to this wire as an "IN" port.
 void attach(Port[] pp_)
          Attaches the ports to this wire as "IN" ports.
 void detach(Port p_)
          Detaches the port from "IN" ports.
 void detach(Port[] pp_)
          Detaches the ports from "IN" ports.
 void disconnect()
          Disconnects all the connected ports from this wire.
 void disconnect(Port p_)
          Disconnects the port from this wire.
 void disconnect(Port[] pp_)
          Disconnects the ports from this wire.
 void duplicate(java.lang.Object source_)
          opies the content of the source_ object to this object.
 Port[] getInPorts()
          Returns all the "IN" ports that are attached to this wire, including shadow ports.
 Port[] getOutPorts()
          Returns all the "OUT" ports that are attached to this wire including shadow ports.
 Port[] getPorts()
          Returns all the ports that are attached to this wire including shadow ports.
 Port[] getPortsExcept(Port excluded_)
          Returns all the ports, except excluded_, that are attached to this wire.
 Port[] getRealInPorts()
          Returns all the real "IN" ports that are attached to this wire.
 Port[] getRealOutPorts()
          Returns all the real "OUT" ports that are attached to this wire.
 Port[] getRealPorts()
          Returns all the ports that are attached to this wire.
 Port[] getRealPortsExcept(Port excluded_)
          Returns all the real ports, except excluded_, that are attached to this wire.
 Port[] getShadowInPorts()
          Returns all the shadow "IN" ports that are attached to this wire.
 Port[] getShadowOutPorts()
          Returns all the shadow "OUT" ports that are attached to this wire.
 Port[] getShadowPorts()
          Returns all the shadow ports that are attached to this wire.
 Port[] getShadowPortsExcept(Port excluded_)
          Returns all the shadow ports, except excluded_, that are attached to this wire.
 java.lang.String info()
           
 Wire inoutSplit(Port target_)
          Splits this wire with respect to the target port.
 boolean isAttachedToBy(Port p_)
          Returns true if the specified port is attached to this wire.
 boolean isAttachedToInBy(Port p_)
          Returns true if the specified port is attached to this wire as IN ports.
 boolean isAttachedToOutBy(Port p_)
          Returns true if the specified port is attached to this wire as OUT ports.
 Wire join(Wire that_)
          Joins the wire that_ to this.
 Wire joinIn(Port p_)
           
 Wire joinInOut(Port p_)
           
 Wire joinOut(Port p_)
           
 Wire split(Port[] pp_)
          Splits the ports from this wire.
 java.lang.String toString()
           
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Wire

public Wire()
Method Detail

duplicate

public void duplicate(java.lang.Object source_)
Description copied from class: DrclObj
opies the content of the source_ object to this object. he subclass must implement this method to realize DrclObj.clone().

Specified by:
duplicate in interface ObjectDuplicable
Overrides:
duplicate in class DrclObj

join

public Wire join(Wire that_)
Joins the wire that_ to this. Assumes that the shadow/client relation among ports in these two wires have been resolved.

Returns:
this wire object; null if something goes wrong.

joinIn

public Wire joinIn(Port p_)

joinOut

public Wire joinOut(Port p_)

joinInOut

public Wire joinInOut(Port p_)

attach

public void attach(Port p_)
Attaches the port to this wire as an "IN" port.


attach

public void attach(Port[] pp_)
Attaches the ports to this wire as "IN" ports.


detach

public void detach(Port p_)
Detaches the port from "IN" ports.


detach

public void detach(Port[] pp_)
Detaches the ports from "IN" ports.


disconnect

public void disconnect()
Disconnects all the connected ports from this wire.


disconnect

public void disconnect(Port p_)
Disconnects the port from this wire.


disconnect

public void disconnect(Port[] pp_)
Disconnects the ports from this wire.


split

public Wire split(Port[] pp_)
Splits the ports from this wire. Those ports are re-connected in the same manner to a new wire.

Returns:
the new wire.

inoutSplit

public Wire inoutSplit(Port target_)
Splits this wire with respect to the target port. This wire becomes the "out" wire of the target port. The method creates, and returns, the "in" wire for the target port.


anyPortExcept

public boolean anyPortExcept(Port excluded_)
Returns true if there exists a port, other than excluded_, which is connected to this wire.


isAttachedToBy

public boolean isAttachedToBy(Port p_)
Returns true if the specified port is attached to this wire.


isAttachedToInBy

public boolean isAttachedToInBy(Port p_)
Returns true if the specified port is attached to this wire as IN ports.


isAttachedToOutBy

public boolean isAttachedToOutBy(Port p_)
Returns true if the specified port is attached to this wire as OUT ports.


getInPorts

public Port[] getInPorts()
Returns all the "IN" ports that are attached to this wire, including shadow ports.


getOutPorts

public Port[] getOutPorts()
Returns all the "OUT" ports that are attached to this wire including shadow ports.


getPorts

public Port[] getPorts()
Returns all the ports that are attached to this wire including shadow ports.


getRealInPorts

public Port[] getRealInPorts()
Returns all the real "IN" ports that are attached to this wire.


getRealOutPorts

public Port[] getRealOutPorts()
Returns all the real "OUT" ports that are attached to this wire.


getRealPorts

public Port[] getRealPorts()
Returns all the ports that are attached to this wire.


getShadowInPorts

public Port[] getShadowInPorts()
Returns all the shadow "IN" ports that are attached to this wire.


getShadowOutPorts

public Port[] getShadowOutPorts()
Returns all the shadow "OUT" ports that are attached to this wire.


getShadowPorts

public Port[] getShadowPorts()
Returns all the shadow ports that are attached to this wire.


getPortsExcept

public Port[] getPortsExcept(Port excluded_)
Returns all the ports, except excluded_, that are attached to this wire.


getRealPortsExcept

public Port[] getRealPortsExcept(Port excluded_)
Returns all the real ports, except excluded_, that are attached to this wire.


getShadowPortsExcept

public Port[] getShadowPortsExcept(Port excluded_)
Returns all the shadow ports, except excluded_, that are attached to this wire.


info

public java.lang.String info()

toString

public java.lang.String toString()
Overrides:
toString in class DrclObj

J-Sim v1.2.1-p7 API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~