CCAFFEINE
0.8.8
|
#include <ParameterPort.h>
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 BaseParameter * | getParameter (char *fieldName)=0 |
ParameterPort for use in user interfaces.
ParameterPort implements a protocol for extracting input from a user. This interface supports the fundamental information for forms, text prompts, GUIs, and sanity checking.
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.
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.