NAME

classic::gov::cca::KeyValuePort -

UNADOPTED Standard: KeyValuePort for use decorating components with strings external to the implementation of the component.

SYNOPSIS

#include <KeyValuePort.h>

Inherits classic::gov::cca::Port.

Detailed Description

UNADOPTED Standard: KeyValuePort for use decorating components with strings external to the implementation of the component.

DEPRECATED: do not use. See ComponentPropertiesService in newer cca spec. Alternative, misleading names for this would be

   EnvironmentPort (which has too many global connotations)


   RegistryPort (which has way too many global connotations)


   PropertiesPort (which will be confused with port properties and java Propertie
s...).


   ParameterPort (which is already taken in the CCAFFEINE framework.).


 

This class is deliberately simpler than java Properties, for compatibility with basic c++ implementations.

In a reasonable framework, each component will just be automatically decorated with one of these if that framework exposes the component to external agents.

The following code fragment illustrates the use of the KeyValuePort by a framework Services implementation to decorate every component with a properties for the frameworks use.

    int err;


    err = addProvidesPort(kvp,createPortInfo('cProps','gov.cca.ComponentProperties',0));


    assert(!err); // cannot fail, due to other framework design features


 

The following code fragment illustrates the use of the port as a service by a component that wants to know/modify what the framework says about it.

   setServices(Services *s) {


     int err;


     err= s->registerUsesPort(kvp,createPortInfo('sProps','gov.cca.ComponentPropertiesService',0));


     assert(!err); // cannot fail, if we adopt it as a well known service.


     Port *p = getPort('sProps');


     KeyValuePort *kvp = dynamic_cast<KeyValuePort *>(p);


     kvp->setValue('gov.babel.guiApplet.URL',


                'http://z.ca.sandia.gov/cgi-bin/babel.asp?component=gov.sandia.viz');


     s->releasePort('sProps');


     s->unregisterUsesPort('sProps');


   }


 

Author:

Version:

Id:

Constructor & Destructor Documentation

{}

Member Function Documentation

Author

Generated automatically by Doxygen for 'Classic' CCA c++ binding (ccaffeine-only) from the source code.