gov.cca.ports.BasicParameterPort Interface Reference

This type of interface is exported for manipulation by other components or by a user-interface (UI) (text or graphic). More...

Inheritance diagram for gov.cca.ports.BasicParameterPort:

Inheritance graph
[legend]
Collaboration diagram for gov.cca.ports.BasicParameterPort:

Collaboration graph
[legend]

List of all members.

Public Member Functions

gov.cca.TypeMap readConfigurationMap () throws gov.cca.CCAException
 Return a TypeMap of runtime configuration parameters.
void writeConfigurationMap (in gov.cca.TypeMap map) throws gov.cca.CCAException
 Copy the parameter values given in map into the internal map, for those parameters which are already defined by the internal map.
array< string > readConfigurationKeys ()
 Fetch the list of keys in the TypeMap that are for public configuration purposes.


Detailed Description

This type of interface is exported for manipulation by other components or by a user-interface (UI) (text or graphic).

This version of the Port is so simple that mere mortal component writers could implement it. It is not nearly so self-documenting at runtime as the full-service ParameterPort.


Member Function Documentation

array< string > gov.cca.ports.BasicParameterPort.readConfigurationKeys (  ) 

Fetch the list of keys in the TypeMap that are for public configuration purposes.

Other values found in the TypeMap must not be changed.

gov.cca.TypeMap gov.cca.ports.BasicParameterPort.readConfigurationMap (  )  throws gov.cca.CCAException

Return a TypeMap of runtime configuration parameters.

It is recommended that the map returned be a clone/copy of the a privately held map, not a shared object reference.

void gov.cca.ports.BasicParameterPort.writeConfigurationMap ( in gov.cca.TypeMap  map  )  throws gov.cca.CCAException

Copy the parameter values given in map into the internal map, for those parameters which are already defined by the internal map.

The outsider does not get to cause arbitrary keys to be copied into the internal map.

Exceptions:
gov.cca.CCAException if TypeMap operations fail.


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

Generated on Thu Mar 17 09:40:09 2011 for cca-spec-babel by  doxygen 1.5.9