gov.cca.ports.ParameterGetListener Interface Reference

This interface is typically implemented by a component writer using the ParameterPortFactory in a very dynamic fashion. More...

List of all members.

Public Member Functions

bool updateParameterPort (in string portName)
 Inform the listener that someone is about to fetch their typemap.


Detailed Description

This interface is typically implemented by a component writer using the ParameterPortFactory in a very dynamic fashion.

Most component writers don't need it.

The ParameterGet listeners are called when the readMap function is called on the ParameterPort interface. The listener (usually the component owning the typemap) can change the contents (title, groups, parameters) of the ParameterPort in their updateParameterPort function. These changed values will be returned to the caller (framework/gui).

This is handy when the contents of one ParameterPort depend on values already set in another ParameterPort on the same component. E.g. selection of a particular chemical reaction mechanism in the first ParameterPort defines the set of chemical species that need initial-concentrations defined in the second ParameterPort.

The fact that looking at a ParameterPort gives an opportunity for it to change will lead to Heisenbugs in the hands of an inept programmer.

The name of the parameter port which is being used is passed so the component using the ParameterPortFactory to manage more than one Parameter port can tell which one is being updated.

The component should return TRUE if the contents of the parameter port were changed (cleared or added to) in the update function or if the component wants to receive all fresh input for current values.

See also:
ParameterSetListener

Member Function Documentation

bool gov.cca.ports.ParameterGetListener.updateParameterPort ( in string  portName  ) 

Inform the listener that someone is about to fetch their typemap.

The return should be true if the listener has changed the ParameterPort definitions.


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

Generated on Mon Sep 14 18:29:48 2009 for cca-spec-babel by  doxygen 1.5.9