YMLPort Class Reference

#include <ymlport.h>

Inheritance diagram for YMLPort:

Inheritance graph
[legend]
Collaboration diagram for YMLPort:

Collaboration graph
[legend]
List of all members.

Public Types

enum  dir_t { dUnknown = -1, dIn, dOut }

Public Member Functions

 YMLPort ()
const char * getName ()
void dumpFullName (std::ostream &stream)
std::string getFullName ()
dir_t getDir ()
YMLNodegetParent ()
void setParent (YMLNode *parent)
YMLPortSidegetInSide ()
YMLPortSidegetOutSide ()
YMLPortgetRemotePort ()
void getRemotePorts (BasicArray< YMLPort * > &ports)
void addConnection (YMLConnection *con)
YMLConnectiongetConnection ()
const BasicArray< YMLConnection * > & getConnections ()
void setID (int id)
int getID ()
virtual void dumpXML (XMLSerializer &stream)
virtual void doFinalize ()
ymlentity_t getType ()

Static Public Attributes

static const int aName = 0
static const int aDir = 1

Protected Member Functions

YMLPortgetRemotePort (YMLConnection *connection)
void resolveDir ()

Member Enumeration Documentation

enum YMLPort::dir_t
 

Enumerator:
dUnknown 
dIn 
dOut 


Constructor & Destructor Documentation

YMLPort::YMLPort  ) 
 

Construct a YMLPort.


Member Function Documentation

const char* YMLPort::getName  )  [inline]
 

Get the port name property.

Returns:
The port name.

void YMLPort::dumpFullName std::ostream &  stream  ) 
 

Print the fullname of this node to the provided stream. The fullname is the concatenation the ports ancestors starting with the root and separated by NAME_DELIM. NAME_DELIM is '.' by default.

Parameters:
stream The output stream.

string YMLPort::getFullName  ) 
 

dir_t YMLPort::getDir  )  [inline]
 

Get the port direction property as a dir_t.

Returns:
The port direction.

YMLNode* YMLPort::getParent  )  [inline]
 

Get the parent node.

Returns:
A pointer to the parent node.

void YMLPort::setParent YMLNode parent  )  [inline]
 

Set the parent node.

Parameters:
parent A pointer to the parent node.

YMLPortSide* YMLPort::getInSide  )  [inline]
 

Get the inside YMLPortSide.

Returns:
A pointer to the inside YMLPortSide.

YMLPortSide* YMLPort::getOutSide  )  [inline]
 

Get the outside YMLPortSide.

Returns:
A pointer to the outside YMLPortSide.

YMLPort * YMLPort::getRemotePort  ) 
 

void YMLPort::getRemotePorts BasicArray< YMLPort * > &  ports  ) 
 

void YMLPort::addConnection YMLConnection con  )  [inline]
 

YMLConnection * YMLPort::getConnection  ) 
 

const BasicArray<YMLConnection *>& YMLPort::getConnections  )  [inline]
 

void YMLPort::setID int  id  ) 
 

int YMLPort::getID  ) 
 

void YMLPort::dumpXML XMLSerializer &  stream  )  [virtual]
 

Print the port as XML to the provided output stream. New lines are prefixed by tabLevel number of tabs.

Parameters:
stream The output stream.

Implements YMLEntity.

virtual void YMLPort::doFinalize  )  [inline, virtual]
 

Calls the finalize function.

Implements YMLEntity.

ymlentity_t YMLPort::getType  )  [inline, virtual]
 

Get the YMLEntity type.

Returns:
ymlPort

Implements YMLEntity.

YMLPort * YMLPort::getRemotePort YMLConnection connection  )  [protected]
 

void YMLPort::resolveDir  )  [protected]
 

Look up the direction attribute string and convert it to a direction type.


Member Data Documentation

const int YMLPort::aName = 0 [static]
 

Location of the name attribute.

const int YMLPort::aDir = 1 [static]
 

Location of the dir attribute.


The documentation for this class was generated from the following files:
Generated on Wed Apr 5 21:05:57 2006 for Sesame by  doxygen 1.4.6