YMLNode Class Reference

#include <ymlnode.h>

Inheritance diagram for YMLNode:

[legend]Collaboration diagram for YMLNode:

[legend]List of all members.

Public Member Functions
	YMLNode ()
virtual	~YMLNode ()
void	addPort (YMLPort *port)
YMLPort *	findPort (const char *name)
int	getNumPorts ()
YMLPort *	getPort (int id)
YMLPort *	getPortByIdx (int idx)
YMLNetwork *	getNetwork () const
void	setNetwork (YMLNetwork *network)
void	dumpFullName (std::ostream &stream)
std::string	getFullName ()
const char *	getName ()
const char *	getClass ()
virtual ymlentity_t	getType ()
void	setTraceChannel (TraceChannel *traceChannel)
TraceChannel *	getTraceChannel ()
void	setChannelID (int channelID)
int	getChannelID () const
void	dumpXMLPorts (XMLSerializer &stream)
virtual void	dumpXML (XMLSerializer &stream)
virtual void	dumpDOT (std::ostream &stream, int tabLevel)
virtual void	doFinalizePorts ()
virtual void	doFinalize ()
virtual void	init ()
Static Public Attributes
static const int	aName = 0
static const int	aClass = 1

---

Constructor & Destructor Documentation

YMLNode::YMLNode (   )

Construct a new YMLNode.

YMLNode::~YMLNode (   )  [virtual]

---

Member Function Documentation

void YMLNode::addPort (  YMLPort *  port  )

Add a port to this node. It will fail to add the port and throw a BasicException if the port name is already in use in this node. Parameters: port  The port to add.

YMLPort * YMLNode::findPort (  const char *  name  )

Find a port by name. Parameters: name  The port name. Returns: A pointer to the YMLPort on success, NULL otherwise.

int YMLNode::getNumPorts (   )  [inline]

Get the number of ports for this node. Returns: number of ports.

YMLPort * YMLNode::getPort (  int  id  )

Get a port by id. Parameters: id  the port id. Returns: A pointer to the YMLPort on success, NULL otherwise.

YMLPort* YMLNode::getPortByIdx (  int  idx  )  [inline]

YMLNetwork* YMLNode::getNetwork (   )  const [inline]

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

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

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

void YMLNode::dumpFullName (  std::ostream &  stream  )

Print the nodes fullname to the provided stream. Parameters: stream  The output stream.

std::string YMLNode::getFullName (   )

Get the nodes fullname as a std::string. Returns: fullname string.

const char* YMLNode::getName (   )  [inline]

Returns: The node name attribute.

const char* YMLNode::getClass (   )  [inline]

Returns: The node class attribute.

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

Get the YMLEntity type. Returns: ymlNode. Implements YMLEntity. Reimplemented in YMLNetwork.

void YMLNode::setTraceChannel (  TraceChannel *  traceChannel  )

TraceChannel * YMLNode::getTraceChannel (   )

void YMLNode::setChannelID (  int  channelID  )  [inline]

int YMLNode::getChannelID (   )  const

void YMLNode::dumpXMLPorts (  XMLSerializer &  stream  )

Print the ports as XML to the provides stream with the specified tabLevel. Parameters: stream  The output stream.

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

Print this node as XML to the provided stream using the specified number of tabs. Parameters: stream  The output stream. Implements YMLEntity. Reimplemented in YMLNetwork.

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

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

void YMLNode::doFinalizePorts (   )  [virtual]

Call finalize on all of the ports.

void YMLNode::doFinalize (   )  [virtual]

Call doFinalizePorts than call finalize on this node. Implements YMLEntity. Reimplemented in YMLNetwork.

virtual void YMLNode::init (   )  [inline, virtual]

Do nothing. Reimplemented in PN, and ProcessLoader.

---

Member Data Documentation

const int YMLNode::aName = 0 [static]

Location of the name property.

const int YMLNode::aClass = 1 [static]

Location of the class property.

---

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

• ymlnode.h
• ymlnode.cpp

---