Prism.core
Interface IPort

All Known Implementing Classes:
ExtensiblePort, Port

public interface IPort

This interface is implemented by any object that wants to represent a port in Prism.

Version:
2.0
Author:
USC Soft. Arch. Group. Contact: Sam Malek malek@usc.edu

Method Summary
 ExtensiblePort getExtensiblePort()
          In situations when the Port is actually more specialized and is an ExtensiblePort, this method returns the ExtensiblePort.
 IPort getMutualPort()
          This method returns the mutual port
 Brick getParentBrick()
          Returns the parent brick of this Port.
 int getPortType()
          Returns the type of port.
 void setExtensiblePort(ExtensiblePort pExtPort)
          Sets the reference of this port object to its ExtensiblePort(child).
 void setMutualPort(IPort pPort)
          Sets the mutual port for this port
 void setParentBrick(Brick pParentBrick)
          Sets the parent brick of this Port.
 

Method Detail

getPortType

int getPortType()
Returns the type of port. Request is equivalent to the notion of Top in C2. Reply is equivalent to the notion of Bottom in C2.

Returns:
int port type

getParentBrick

Brick getParentBrick()
Returns the parent brick of this Port.

Returns:
Brick parent Brick

setParentBrick

void setParentBrick(Brick pParentBrick)
Sets the parent brick of this Port.


getExtensiblePort

ExtensiblePort getExtensiblePort()
In situations when the Port is actually more specialized and is an ExtensiblePort, this method returns the ExtensiblePort.

Returns:
ExtensiblePort child ExtensiblePort

setExtensiblePort

void setExtensiblePort(ExtensiblePort pExtPort)
Sets the reference of this port object to its ExtensiblePort(child).

Parameters:
pExtPort - child ExtensiblePort

setMutualPort

void setMutualPort(IPort pPort)
Sets the mutual port for this port

Parameters:
pPort - Port to be added

getMutualPort

IPort getMutualPort()
This method returns the mutual port

Returns:
IPort the mutual port