YMLEntityFactory Class Reference

#include <ymlentityfactory.h>

Inheritance diagram for YMLEntityFactory:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual YMLConnectioncreateConnection (YMLPort *inPort, YMLPort *outPort)=0
virtual YMLNetworkcreateNetwork (const char *name, const char *className)=0
virtual YMLNodecreateNode (const char *name, const char *className)=0
virtual YMLLinkcreateLink (const char *object1, const char *port1, const char *object2, const char *port2)=0
virtual YMLPortcreatePort (const char *name)=0

Member Function Documentation

virtual YMLConnection* YMLEntityFactory::createConnection YMLPort inPort,
YMLPort outPort
[pure virtual]
 

This function is called to create a resolved YMLConnection. YMLConnections go directly from node to node with out intermeadiate ports. YMLConnections are created is a second pass after all nodes, netowrks, and links are been added.

Parameters:
inPort The incomming port.
outPort The outgoing port.
Returns:
A pointer to a newly constructed YMLConnection.

Implemented in PNYMLEntityFactory, and DefaultYMLEntityFactory.

virtual YMLNetwork* YMLEntityFactory::createNetwork const char *  name,
const char *  className
[pure virtual]
 

Create a new YMLNetwork entity.

Parameters:
name The name of the network.
className The network class. This can be used to decide which type of YMLNetwork to create.
Returns:
A pointer to the YMLNetwork.

Implemented in PNYMLEntityFactory, and DefaultYMLEntityFactory.

virtual YMLNode* YMLEntityFactory::createNode const char *  name,
const char *  className
[pure virtual]
 

Create a new YMLNode enity.

Parameters:
name The name of the node.
className The node class. This can be used to decide which type of YMLNode to create.
Returns:

Implemented in PNYMLEntityFactory, and DefaultYMLEntityFactory.

virtual YMLLink* YMLEntityFactory::createLink const char *  object1,
const char *  port1,
const char *  object2,
const char *  port2
[pure virtual]
 

Create a new YMLLink entity. It is not necessary to actually connect the objects in implementations of this function.

Parameters:
object1 The name of the first node or network.
port1 The name of the first port.
object2 The name of the second node or network.
port2 The name of the second port.
Returns:
A pointer to the newly created YMLNode.

Implemented in PNYMLEntityFactory, and DefaultYMLEntityFactory.

virtual YMLPort* YMLEntityFactory::createPort const char *  name  )  [pure virtual]
 

Create a new YMLPort entity.

Parameters:
name The port name.
Returns:
A pointer to the newly created YMLPort.

Implemented in PNYMLEntityFactory, and DefaultYMLEntityFactory.


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