type
|
Yes |
A scalar string indicating the parameter type to use on creating an instance of the task.
Basic scalar data type string values are:
BYTE, INT, UINT, LONG, ULONG, LONG64,ULONG64, FLOAT, DOUBLE, COMPLEX, DCOMPLEX, STRING, BOOLEAN, LIST, HASH, DICTIONARY, ORDEREDHASH
Basic array data types must include the dimensions key and type string values are:
BYTEARRAY, INTARRAY, UINTARRAY, LONGARRAY, ULONGARRAY, LONG64ARRAY,ULONG64ARRAY, FLOATARRAY, DOUBLEARRAY, COMPLEXARRAY, DCOMPLEXARRAY, STRINGARRAY, BOOLEANARRAY
The type key value can be set to a class name to indicate that the user must provide an object of the given class name.
|
dimensions
|
No for scalar, Yes for array
|
A scalar string specifying the required dimensions for a parameter, if type specified is an *ARRAY type.
If the number of elements in any dimension does not matter, then use an asterisk ('*') for that dimension.
- Example of a three-element array declaration: "[3]"
- Example of a 1D array with any number of elements: "[*]"
- Example of a 2D array with any number of columns or rows: "[*, *]"
- Example of a 2D array with a specific number of elements: "[3, 256]"
- Example of a 2D array with any number of columns and 3 rows: "[*, 3]"
|
additional keys
|
No |
Depending on the parameter there may be additional keys available to define. For example for a type set to STRING, there is fold_case and choice_list. You could use the QueryProperty static method on the given parameter class to discover the available keys:
IDL>print, IDLParameterString.QueryProperty()
|