YMLLink Class Reference

#include <ymllink.h>

Inheritance diagram for YMLLink:

[legend]Collaboration diagram for YMLLink:

[legend]List of all members.

Public Member Functions
	YMLLink ()
void	setPortSide (int i, YMLPortSide *portSide)
YMLPortSide *	getPortSide (int i)
const char *	getNodeName (int i)
const char *	getPortName (int i)
YMLNetwork *	getNetwork ()
void	setNetwork (YMLNetwork *network)
void	setCommChannelID (const int id)
int	getCommChannelID ()
virtual void	dumpXML (XMLSerializer &stream)
virtual void	dumpDOT (std::ostream &stream, int tabLevel)
virtual void	doFinalize ()
virtual ymlentity_t	getType ()

---

Constructor & Destructor Documentation

YMLLink::YMLLink (   )

Construct a YMLLink.

---

Member Function Documentation

void YMLLink::setPortSide (  int  i, YMLPortSide *  portSide )  [inline]

Set a YMLPortSide. Parameters: i  The side to set. portSide  A pointer to the YMLPortSide.

YMLPortSide* YMLLink::getPortSide (  int  i  )  [inline]

Get a YMLPortSide. Parameters: i  The side to get. Returns: A pointer to the YMLPortSide.

const char * YMLLink::getNodeName (  int  i  )

Get the name of one of the two nodes this link is connected to. Parameters: i  The node number. Either 0 or 1. Returns: The name of the node.

const char * YMLLink::getPortName (  int  i  )

Get the name of one of the two ports this link is connected to. Parameters: i  The port number. Either 0 or 1. Returns: The name of the port.

YMLNetwork* YMLLink::getNetwork (   )  [inline]

Get the parent network. Returns: A pointer to the parent YMLNetwork.

void YMLLink::setNetwork (  YMLNetwork *  network  )  [inline]

Set the parent network. Parameters: network  A pointer to the parent YMLNetwork.

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

int YMLLink::getCommChannelID (   )  [inline]

void YMLLink::dumpXML (  XMLSerializer &  stream  )  [virtual]

Print this link as XML. Parameters: stream  The output stream. tabLevel  The number of tabs to use. Implements YMLEntity.

void YMLLink::dumpDOT (  std::ostream &  stream, int  tabLevel )  [virtual]

Print this link as a GraphViz graph. Parameters: stream  The output stream. tabLevel  The number of tabs to use. Reimplemented from YMLEntity.

virtual void YMLLink::doFinalize (   )  [inline, virtual]

Simply calls finalize. Implements YMLEntity.

virtual ymlentity_t YMLLink::getType (   )  [inline, virtual]

Get the YMLEntity type. Returns: ymlLink. Implements YMLEntity. Reimplemented in YMLConnection.

---

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

• ymllink.h
• ymllink.cpp

---