ParameterPort Class Reference

#include <ParameterPort.h>

Inheritance diagram for ParameterPort:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual char * getConfigurationString (char *infix)=0
virtual char * getConfigurationString (char *infix, char *fieldName)=0
virtual int setConfigurationString (char *fieldName, char *value)=0
virtual BaseParametergetParameter (char *fieldName)=0


Detailed Description

ParameterPort for use in user interfaces.
Author:
Ben Allan, 9/30/1999, Sandia National Laboratories.
Id
ParameterPort.h,v 1.8 2005/02/01 00:14:31 baallan Exp
ParameterPort implements a protocol for extracting input from a user. This interface supports the fundamental information for forms, text prompts, GUIs, and sanity checking.

See also:
BaseParameter

DefaultParameterPort

In a reasonable framework, each component advertising a provides port of this type will implement that provides port with a local instance of the ParameterPort obtained from a cca std factory uses interface supported by the framework, as implementing the port directly would be a monumental waste of time.

Member Function Documentation

virtual char* ParameterPort::getConfigurationString ( char *  infix  )  [pure virtual]

Return stringified form of all known requests, with embedded title/tab information. If bogus request, returns null. The string is likely to contain carriage returns. Currently it is an ad hoc format. Eventually it may be an xml string.

Implemented in DefaultParameterPort, and ConfigurableParameterPort.

virtual char* ParameterPort::getConfigurationString ( char *  infix,
char *  fieldName 
) [pure virtual]

Return the stringified form of the request with name "fieldName". If fieldName unknown, returns null.

Implemented in DefaultParameterPort, and ConfigurableParameterPort.

virtual int ParameterPort::setConfigurationString ( char *  fieldName,
char *  value 
) [pure virtual]

Store the value for stringified form of answer (value) into one request (fieldname). There is no massed setConfig function.

Implemented in DefaultParameterPort, and ConfigurableParameterPort.

virtual BaseParameter* ParameterPort::getParameter ( char *  fieldName  )  [pure virtual]

Returns the actual parameter object named.

Implemented in DefaultParameterPort, and ConfigurableParameterPort.


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

Generated on Thu Sep 17 08:21:25 2009 for CCAFFEINE by  doxygen 1.5.9