Name
condition sample, conditionsample, kPMConditionConditionSample — Conditional on a sample's successful conclusion.
Synopsis
condition sample structure { invert, type, sample };
invert : boolean, default, optional |
type : string, choice |
sample : sample structure
|
Description
Conditional on a sample's successful conclusion.
Try and avoid using condition sample, the condition is expensive to run.
Fields
invert. Invert the condition's conclusion.
Conditions are designed to positively identify specific states. Many events will want a condition to confirm that a specific state is not occuring. To reverse the role of a positive condition, use the invert field.
If a condition is true, and the invert field is set, the condition will invert the true and return false.
If a condition is false, and the invert field is set, the condition will invert the false and return true.
invert is a boolean. If invert is omitted, the default false is used. invert is optional.
type. Type of condition to test.
type is a string. type must be sample, kPMConditionType_Sample.
sample. Sample to run.
sample is a sample structure.