YMLPortSide Class Reference

#include <ymlportside.h>

Collaboration diagram for YMLPortSide:

[legend]List of all members.

Public Types
enum	side_t { sIn, sOut }
Public Member Functions
	YMLPortSide (YMLPort *port, YMLPortSide *otherSide, side_t type)
YMLPortSide *	getOtherSide ()
YMLPort *	getPort ()
side_t	getType ()
int	getDir ()
int	getNumLinks ()
int	addLink (YMLPortSide *side)
YMLPortSide *&	getLink (int i)
YMLPortSide *&	operator[] (int i)
void	setCommChannelID (const int id)
int	getCommChannelID ()

---

Member Enumeration Documentation

enum YMLPortSide::side_t

Enumerator: sIn  sOut

---

Constructor & Destructor Documentation

YMLPortSide::YMLPortSide (  YMLPort *  port, YMLPortSide *  otherSide, side_t  type )

Construct a port side. Parameters: port  A pointer to the parent port. otherSide  A pointer to the other side. type  The side type.

---

Member Function Documentation

YMLPortSide* YMLPortSide::getOtherSide (   )  [inline]

Get the other side. Returns: A pointer to the other side.

YMLPort* YMLPortSide::getPort (   )  [inline]

Get the associated port. Returns: A pointer to the port class.

side_t YMLPortSide::getType (   )  [inline]

Get the side type. Returns: Either YMLPortSide::sIn or YMLPortSide::sOut.

int YMLPortSide::getDir (   )

Get the port direction. Returns: The port direction. Either YMLPort::dIn, or dOut

int YMLPortSide::getNumLinks (   )  [inline]

Returns: The number of links connected to this port.

int YMLPortSide::addLink (  YMLPortSide *  side  )  [inline]

Add a link to this port side. Parameters: side  The remote port side to be linked. Returns: The link id.

YMLPortSide*& YMLPortSide::getLink (  int  i  )  [inline]

Get a link by id. Parameters: i  The link id. Returns: A pointer to the link.

YMLPortSide*& YMLPortSide::operator[] (  int  i  )  [inline]

a convience function for getLink(); Parameters: i  The link id. Returns: A pointer to the link.

void YMLPortSide::setCommChannelID (  const int  id  )  [inline]

int YMLPortSide::getCommChannelID (   )  [inline]

---

The documentation for this class was generated from the following files:

• ymlportside.h
• ymlportside.cpp

---