Next: Reference Manual
Up: PAR Interface to the ADAM Parameter System
Previous: The C Interface
Where T is one of d, i, l, r and TYPE is the corresponding C
type, the function prototypes are:
- void parCancl ( const char *param, int *status );
- Cancel a parameter
- void parChoic
- ( const char *param, const char *defaul,
const char *opts, int null, char *value,
int value_length, int *status );
Obtain from a parameter a character value selected from a menu
of options
- void parChoiv
- ( const char *param, int maxval, const char *opts,
char *const *values, int values_length,
int *actval, int *status );
Obtain from a parameter a list of character values selected from
a menu of options
- void parDef0c ( const char *param, const char *value,
int *status );
- Set a scalar character dynamic default parameter value
- void parDef0T ( const char *param, TYPE value,
int *status );
- Set a scalar dynamic default parameter value
- void parDef1c
- ( const char *param, int nval,
char *const *values, int values_length,
int *status );
Set a vector of character values as the dynamic default for a parameter
- void parDef1T ( const char *param, int nval,
const TYPE *values, int *status );
- Set a vector of values as the dynamic default for a parameter
- void parDefnc
- ( const char *param, int ndim, const int *maxd,
char *const *values, int values_length, const int *actd,
int *status );
Set an array of character values as the dynamic default for a parameter
- void parDefnT
- ( const char *param, int ndim, const int *maxd,
const TYPE *values, const int *actd,
int *status );
Set an array of values as the dynamic default for a parameter
- void parExacc
- ( const char *param, int nvals, char *const *values,
int values_length, int *status );
Obtain an exact number of character values from a parameter
- void parExacT ( const char *param, int nvals, TYPE *values, int *status );
- Obtain an exact number of values from a parameter
- void parGdr0T
- ( const char *param, TYPE defaul, TYPE vmin,
TYPE vmax, int null, TYPE *value,
int *status );
Obtain a scalar value within a given range from a parameter
- void parGdr1T
- ( const char *param, int nvals,
TYPE *defaul, TYPE vmin,
TYPE vmax, int null, TYPE *values,
int *status );
Obtain an exact number of values within a given range from a parameter
- void parGdrvT
- ( const char *param, int maxval, TYPE vmin,
TYPE vmax, TYPE *values,
int *actval, int *status );
Obtain a vector of values within a given range from a parameter
- void parGet0c ( const char *param, char *value,
int value_length, int *status );
- Obtain a scalar character value from a parameter
- void parGet0T ( const char *param,
TYPE *value, int *status );
- Obtain a scalar value from a parameter
- void parGet1c
- ( const char *param, int maxval,
char *const *values, int values_length,
int *actval, int *status );
Obtain a vector of character values from a parameter
- void parGet1T
- ( const char *param, int maxval,
TYPE *values, int *actval,
int *status );
Obtain a vector of values from a parameter
- void parGetnc
- ( const char *param, int ndim, const int *maxd,
char *const *values, int values_length,
int *actd, int *status );
Obtain a character array parameter value
- void parGetnT
- ( const char *param, int ndim, const int *maxd,
TYPE *values, int *actd,
int *status );
Obtain an array parameter value
- void parGetvc
- ( const char *param, int maxval,
char *const *values, int values_length,
int *actval, int *status );
Obtain a vector of character values from a parameter regardless of its
shape
- void parGetvT
- ( const char *param, int maxval,
TYPE *values, int *actval,
int *status );
Obtain a vector of values from a parameter regardless of its shape
- void parGeven
- ( const char *param, int defaul, int vmin, int vmax,
int null, int *value, int *status );
Obtain an even integer value from a parameter
- void parGodd
- ( const char *param, int defaul, int vmin, int vmax,
int null, int *value, int *status );
Obtain an odd integer value from a parameter
- void parGrm1T
- ( const char *param, int nvals,
const TYPE *defaul,
const TYPE *vmin,
const TYPE *vmax, int null,
TYPE *values, int *status );
Obtain from a parameter an exact number of values each within a
given range
- void parGrmvT
- ( const char *param, int maxval,
const TYPE *vmin,
const TYPE *vmax,
const TYPE *values, int *actval,
int *status );
Obtain from a parameter a vector of values each within a given
range
- void parGtd0l ( const char *param, int defaul, int null,
int *value, int *status );
- Obtain a logical value from a parameter with a dynamic default
- void parMaxc ( const char *param, const char *value,
int *status );
- Set a maximum character value for a parameter
- void parMaxT ( const char *param, TYPE value,
int *status );
- Set a maximum value for a parameter
- void parMinc ( const char *param, const char *value,
int *status );
- Set a minimum character value for a parameter
- void parMinT ( const char *param, TYPE value,
int *status );
- Set a minimum value for a parameter
- void parMix0T
- ( const char *param, const char *defaul,
TYPE vmin, TYPE vmax,
const char *opts, int null, char *value,
int value_length, int *status );
Obtain from a parameter a character value either from a menu of
options or as a numeric value within a given range
- void parMixvT
- ( const char *param, int maxval, TYPE vmin,
TYPE vmax, const char *opts,
char *const *values, int values_length,
int *actval, int *status );
Obtain from a parameter, character values either selected from a
menu of options or as numeric values within a given range
- void parPromt ( const char *param, const char *prompt,
int *status );
- Set a new prompt string for a parameter
- void parPut0c ( const char *param, const char *value,
int *status );
- Put a scalar character value into a parameter
- void parPut0T ( const char *param, TYPE value,
int *status );
- Put a scalar value into a parameter
- void parPut1c
- ( const char *param, int nval,
char *const *values, int values_length,
int *status );
Put a vector of character values into a parameter
- void parPut1T( const char *param, int nval,
const TYPE *values, int *status );
- Put a vector of values into a parameter
- void parPutnc
- ( const char *param, int ndim, const int *maxd,
char *const *values, int values_length,
const int *actd, int *status );
Put an array of character values into a parameter
- void parPutnT
- ( const char *param, int ndim, const int *maxd,
const TYPE *values, const int *actd,
int *status );
Put an array of values into a parameter
- void parPutvc
- ( const char *param, int nval,
char *const *values, int values_length,
int *status );
Put an array of character values into a parameter as if the parameter
were a vector
- void parPutvT ( const char *param, int nval,
const TYPE *values, int *status );
- Put an array of values into a parameter as if the parameter were a
vector
- void parState ( const char *param, int *state,
int *status );
- Inquire the state of a parameter
- void parUnset ( const char *param, const char *which,
int *status );
- Cancel various parameter control values.
Next: Reference Manual
Up: PAR Interface to the ADAM Parameter System
Previous: The C Interface
PAR Interface to the ADAM Parameter System
Starlink User Note 114
Malcolm J. Currie
Alan J. Chipperfield
1999 September 24
E-mail:ussc@star.rl.ac.uk