gov.cca.ports.ParameterPort 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.ParameterPort:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

string readTitle ()
 Fetch configuration title.
array< string > readGroupNames ()
 Fetch the names of groups.
string readGroupTitle (in string groupName) throws gov.cca.CCAException
 Fetch UI-appropriate name for group.
array< string > readGroupKeys (in string groupName) throws gov.cca.CCAException
 Fetch data item keys associated with groupName.
string readHelp (in string key) throws gov.cca.CCAException
 Fetch the help string for key.
string readPrompt (in string key) throws gov.cca.CCAException
 Fetch the prompt string for key.
bool hasBounds (in string key) throws gov.cca.CCAException
 By default, bounds are defined except for complex numbers booleans, and strings.
bool hasChoices (in string key) throws gov.cca.CCAException
 By default, lists of choices are not defined for scalars or arrays.
bool readDefaultBoolean (in string key) throws gov.cca.CCAException
 Fetch the default for boolean-typed key.
string readDefaultString (in string key) throws gov.cca.CCAException
 Fetch the default for string-typed key.
int readDefaultInt (in string key) throws gov.cca.CCAException
 Fetch the default for integer-typed key.
long readDefaultLong (in string key) throws gov.cca.CCAException
 Fetch the default for long-typed key.
float readDefaultFloat (in string key) throws gov.cca.CCAException
 Fetch the default for float-typed key.
double readDefaultDouble (in string key) throws gov.cca.CCAException
 Fetch the default for double-typed key.
fcomplex readDefaultFcomplex (in string key) throws gov.cca.CCAException
 Fetch the default for fcomplex-typed key.
dcomplex readDefaultDcomplex (in string key) throws gov.cca.CCAException
 Fetch the default for dcomplex-typed key.
array< string > readDefaultStringArray (in string key) throws gov.cca.CCAException
 Fetch the default for string-array-typed key.
array< bool > readDefaultBooleanArray (in string key) throws gov.cca.CCAException
 Fetch the default for boolean-array-typed key.
array< int > readDefaultIntArray (in string key) throws gov.cca.CCAException
 Fetch the default for integer-array-typed key.
array< long > readDefaultLongArray (in string key) throws gov.cca.CCAException
 Fetch the default for long-array-typed key.
array< float > readDefaultFloatArray (in string key) throws gov.cca.CCAException
 Fetch the default for float-array-typed key.
array< double > readDefaultDoubleArray (in string key) throws gov.cca.CCAException
 Fetch the default for double-array-typed key.
array< fcomplex > readDefaultFcomplexArray (in string key) throws gov.cca.CCAException
 Fetch the default for fcomplex-array-typed key.
array< dcomplex > readDefaultDcomplexArray (in string key) throws gov.cca.CCAException
 Fetch the default for dcomplex-array-typed key.
void readBoundsInt (in string key, out int low, out int high) throws gov.cca.CCAException
 Fetch the bounds for integer-typed key.
void readBoundsLong (in string key, out long low, out long high) throws gov.cca.CCAException
 Fetch the bounds for long-typed key.
void readBoundsFloat (in string key, out float low, out float high) throws gov.cca.CCAException
 Fetch the bounds for float-typed key.
void readBoundsDouble (in string key, out double low, out double high) throws gov.cca.CCAException
 Fetch the bounds for double-typed key.
array< string > readChoicesString (in string key) throws gov.cca.CCAException
 Fetch the choices for string-typed key.
array< int > readChoicesInt (in string key) throws gov.cca.CCAException
 Fetch the choices for integer-typed key.
array< long > readChoicesLong (in string key) throws gov.cca.CCAException
 Fetch the choices for long-typed key.
array< float > readChoicesFloat (in string key) throws gov.cca.CCAException
 Fetch the choices for float-typed key.
array< double > readChoicesDouble (in string key) throws gov.cca.CCAException
 Fetch the default for double-typed key.
array< fcomplex > readChoicesFcomplex (in string key) throws gov.cca.CCAException
 Fetch the choices for fcomplex-typed key.
array< dcomplex > readChoicesDcomplex (in string key) throws gov.cca.CCAException
 Fetch the choices for dcomplex-typed key.


Detailed Description

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

By using the port ParameterFactory the component writer never actually has to implement this port directly. The recommended instance name for this port type is "CONFIG", if a component provides only one such port. Component assembly or user interface rendering agents might assume this name. However, clever agents will act based on port type rather than port instance name.

Data types represented: Anything representable in a TypeMap. The following auxiliary information is managed for the benefit of component end-user, UI, and other agents. Per map:

Special notes:


Member Function Documentation

bool gov.cca.ports.ParameterPort.hasBounds ( in string  key  )  throws gov.cca.CCAException

By default, bounds are defined except for complex numbers booleans, and strings.

On array types, bounds apply element-wise. i.e. low <= arr[i] <= high for all i.

Returns:
true if simple bounds are defined for a key.
Exceptions:
gov.cca.CCAException if key is unknown.

bool gov.cca.ports.ParameterPort.hasChoices ( in string  key  )  throws gov.cca.CCAException

By default, lists of choices are not defined for scalars or arrays.

Choices are applied element-wise for array types. I.e. (arr[i] IN choice-set) == true for all i.

Returns:
true if choice list is defined for a key.
Exceptions:
gov.cca.CCAException if key is unknown.

void gov.cca.ports.ParameterPort.readBoundsDouble ( in string  key,
out double  low,
out double  high 
) throws gov.cca.CCAException

Fetch the bounds for double-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

void gov.cca.ports.ParameterPort.readBoundsFloat ( in string  key,
out float  low,
out float  high 
) throws gov.cca.CCAException

Fetch the bounds for float-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

void gov.cca.ports.ParameterPort.readBoundsInt ( in string  key,
out int  low,
out int  high 
) throws gov.cca.CCAException

Fetch the bounds for integer-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

void gov.cca.ports.ParameterPort.readBoundsLong ( in string  key,
out long  low,
out long  high 
) throws gov.cca.CCAException

Fetch the bounds for long-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< dcomplex > gov.cca.ports.ParameterPort.readChoicesDcomplex ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for dcomplex-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< double > gov.cca.ports.ParameterPort.readChoicesDouble ( in string  key  )  throws gov.cca.CCAException

Fetch the default for double-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< fcomplex > gov.cca.ports.ParameterPort.readChoicesFcomplex ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for fcomplex-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< float > gov.cca.ports.ParameterPort.readChoicesFloat ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for float-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< int > gov.cca.ports.ParameterPort.readChoicesInt ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for integer-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< long > gov.cca.ports.ParameterPort.readChoicesLong ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for long-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< string > gov.cca.ports.ParameterPort.readChoicesString ( in string  key  )  throws gov.cca.CCAException

Fetch the choices for string-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

bool gov.cca.ports.ParameterPort.readDefaultBoolean ( in string  key  )  throws gov.cca.CCAException

Fetch the default for boolean-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< bool > gov.cca.ports.ParameterPort.readDefaultBooleanArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for boolean-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

dcomplex gov.cca.ports.ParameterPort.readDefaultDcomplex ( in string  key  )  throws gov.cca.CCAException

Fetch the default for dcomplex-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< dcomplex > gov.cca.ports.ParameterPort.readDefaultDcomplexArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for dcomplex-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

double gov.cca.ports.ParameterPort.readDefaultDouble ( in string  key  )  throws gov.cca.CCAException

Fetch the default for double-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< double > gov.cca.ports.ParameterPort.readDefaultDoubleArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for double-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

fcomplex gov.cca.ports.ParameterPort.readDefaultFcomplex ( in string  key  )  throws gov.cca.CCAException

Fetch the default for fcomplex-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< fcomplex > gov.cca.ports.ParameterPort.readDefaultFcomplexArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for fcomplex-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

float gov.cca.ports.ParameterPort.readDefaultFloat ( in string  key  )  throws gov.cca.CCAException

Fetch the default for float-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< float > gov.cca.ports.ParameterPort.readDefaultFloatArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for float-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

int gov.cca.ports.ParameterPort.readDefaultInt ( in string  key  )  throws gov.cca.CCAException

Fetch the default for integer-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< int > gov.cca.ports.ParameterPort.readDefaultIntArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for integer-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

long gov.cca.ports.ParameterPort.readDefaultLong ( in string  key  )  throws gov.cca.CCAException

Fetch the default for long-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< long > gov.cca.ports.ParameterPort.readDefaultLongArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for long-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

string gov.cca.ports.ParameterPort.readDefaultString ( in string  key  )  throws gov.cca.CCAException

Fetch the default for string-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< string > gov.cca.ports.ParameterPort.readDefaultStringArray ( in string  key  )  throws gov.cca.CCAException

Fetch the default for string-array-typed key.

Exceptions:
gov.cca.CCAException if key is unknown or mistyped.

array< string > gov.cca.ports.ParameterPort.readGroupKeys ( in string  groupName  )  throws gov.cca.CCAException

Fetch data item keys associated with groupName.

Array order will be the same as the order in which the additions were made in the ParameterPortFactory interface.

Exceptions:
gov.cca.CCAException if groupName is unknown.

array< string > gov.cca.ports.ParameterPort.readGroupNames (  ) 

Fetch the names of groups.

Each page in a tabbed dialog goes with a group, for example. Group names should be a simple word without whitespace.

string gov.cca.ports.ParameterPort.readGroupTitle ( in string  groupName  )  throws gov.cca.CCAException

Fetch UI-appropriate name for group.

Group name and group title may be the same, if simple. Group title can be complex if desired.

Exceptions:
gov.cca.CCAException if groupName is unknown.

string gov.cca.ports.ParameterPort.readHelp ( in string  key  )  throws gov.cca.CCAException

Fetch the help string for key.

Exceptions:
gov.cca.CCAException if key is unknown.

string gov.cca.ports.ParameterPort.readPrompt ( in string  key  )  throws gov.cca.CCAException

Fetch the prompt string for key.

Exceptions:
gov.cca.CCAException if key is unknown.

string gov.cca.ports.ParameterPort.readTitle (  ) 

Fetch configuration title.

Returns:
Description of data set.


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