Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 117 / 357

Chapter 5 Configuration APIs 117
5.3.2.2 PicamRangeConstraint
Description
PicamRangeConstraint
defines the constraints placed a numeric variable whose value
lies within a linear range of numeric values.
Structure Definition
The structure definition for
PicamRangeConstraint
is:
typedef struct PicamRangeConstraint
{
PicamConstraintScope scope;
PicamConstraintSeverity severity;
pibln empty_set;
piflt minimum;
piflt maximum;
piflt increment;
const piflt* excluded_values_array;
piint excluded_values_count;
const piflt* outlying_values_array;
piint outlying_values_count;
} PicamRangeConstraint;
Variable Definitions
The variables required by
PicamRangeConstraint
are:
scope: The scope of the constraint.
severity:
The severity of the constraint.
empty_set: Indicates when there are no valid values within the range.
Valid values are:
• TRUE
There are no valid values within the range.
When TRUE, only
scope and severity are relevant.
• FALSE
There is at least one valid value within the range.
minimum:
The smallest value within the range.
NOTE:
outlying_values_array may include a smaller value.
maximum:
The largest value within the range.
NOTE:
outlying_values_array may include a larger value.
increment:
The numeric gap between consecutive values within the
range.
excluded_values_array:
The set of values within the range (excluding minimum and
maximum ) that is not valid.
This is null when all values within the range are valid.
excluded_values_count:
The number of items within excluded_values_array .
This is 0 when there are no excluded values.
outlying_values_array: The set of valid values that lie outside of the range of values.
This is null when no valid values fall outside of the range.
outlying_values_count:
The number of items within outlying_values_array .
This is 0 when there are no outlying values.