BuilderModel Class Reference

#include <BuilderModel.h>

Inheritance diagram for BuilderModel:

Inheritance graph
[legend]
Collaboration diagram for BuilderModel:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void initScript ()=0
virtual void addComponentChangedListener (ComponentChangedListener *l)=0
virtual std::string pullDownFromPallet (const ::std::string &className, const ::std::string &instanceName)=0
virtual std::string pullDownFromPallet (const ::std::string &className)=0
virtual int disconnect (const char *fromInstance, const char *providesInstance, const char *toInstance, const char *usesInstance)=0
virtual int connect (const char *fromInstance, const char *providesInstance, const char *toInstance, const char *usesInstance)=0
virtual ::std::map
< ::std::string,
ComponentInfo_shared > 
getArena ()=0
virtual std::vector< std::string > getPallet ()=0
virtual std::vector< std::string > getInstanceNames ()=0
virtual std::vector< std::string > getComponentProperties (::std::string &instanceName)=0
virtual const std::string getComponentProperty (const char *instanceName, const char *key)=0
virtual void setComponentProperty (const char *instanceName, const char *key, const char *value)=0
virtual int loadPorts (const std::string &libPathName)=0


Detailed Description

This is the Model part of a Model-View-Controller design pattern. This is the object that actually deals first hand with the connection framework itself. It has a concept of a pallet - a set of instantiatable classes maintained by the connection framework; a concept of an arena - a space where instantiated components are hooked together to create a program, and a go() or method that fires the flow executive in the connection framework.

Member Function Documentation

virtual void BuilderModel::initScript (  )  [pure virtual]

do things that set up the default contents of the frame.

Implemented in DefaultBuilderModel.

virtual void BuilderModel::addComponentChangedListener ( ComponentChangedListener l  )  [pure virtual]

Add a listener for a change in the status of a component.

Implemented in DefaultBuilderModel.

virtual std::string BuilderModel::pullDownFromPallet ( const ::std::string &  className,
const ::std::string &  instanceName 
) [pure virtual]

Instantiate a component that presently exists on the pallet and place it in the arena with the given instance name.

Returns:
A string that is the instantiated components unique instance name. Rturns null if class not found.

virtual std::string BuilderModel::pullDownFromPallet ( const ::std::string &  className  )  [pure virtual]

Instantiate a component that presently exists on the pallet and place it in the arena.

Returns:
A string that is the instantiated components unique instance name. returns null if class not found.

virtual int BuilderModel::disconnect ( const char *  fromInstance,
const char *  providesInstance,
const char *  toInstance,
const char *  usesInstance 
) [pure virtual]

Disconnect component, already residing in the arena, from another component in the arena. Note that the order here honors the port flow. Port's flow from "fromInstance" to toInstance in the argument list. Data flow moves in the opposite direction of port flow. Returns 0 if ok, -1 if connection vetoed -2 if input bogus.

Implemented in DefaultBuilderModel.

virtual int BuilderModel::connect ( const char *  fromInstance,
const char *  providesInstance,
const char *  toInstance,
const char *  usesInstance 
) [pure virtual]

Connect the instance of an already "pulled down" (instantiated) component, already residing in the arena, to another component in the arena. Note that the order here honors the port flow. Port's flow from "fromInstance" to toInstance in the argument list. Data flow moves in the opposite direction of port flow. Returns 0 if ok, -1 if connection vetoed -2 if input bogus.

Implemented in DefaultBuilderModel.

virtual ::std::map< ::std::string, ComponentInfo_shared > BuilderModel::getArena (  )  [pure virtual]

The arena is where instantiated components live and can be subsequently connected together. key is String-valued instance name of the instantiated component.

Implemented in DefaultBuilderModel.

virtual std::vector< std::string > BuilderModel::getPallet (  )  [pure virtual]

The pallet is an array of String's that are the class names (types) of components that can be instantiated by the connection framework. On return, pallet_length holds the length of result.

Implemented in DefaultBuilderModel.

virtual std::vector< std::string > BuilderModel::getInstanceNames (  )  [pure virtual]

return list of all names for instances.

Implemented in DefaultBuilderModel.


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

Generated on Tue Apr 28 03:12:49 2009 for CCAFFEINE by  doxygen 1.5.5