|
UserLimit.ConditionMask
The bitmask used for Custom condition types.
Version History
Introduced in MPX 2.0.
Type
UInt32
Index
| |
| Index Type |
Description |
| Int32 |
The index of the condition whose trigger mask is being accessed. Valid index values include 0 and 1. |
|
Common Exceptions
| |
| Error |
Occurs when... |
| UserLimitCannotConfigure |
Attempting to set ConditionMask and the user limit is not in a ‘being configured’ state.
To resolve the problem, call UserLimit.ConfigurationBegin to begin configuring the user limit.
|
|
Visual Basic
Syntax
Property ConditionMask As UInt32(index As Int32)
Sample Code
| |
Dim userLimit As Mpx.UserLimit = controller.Axis(0).UserLimit(0)
userLimit.ConfigurationReset() ' Reset user limit configuration before configuring it
userLimit.ConfigurationBegin() ' Begin configuration
' Configure user limit
userLimit.TriggerType = Mpx.UserLimitTrigger.SingleCondition
userLimit.ConditionType(0) = Mpx.UserLimitConditionType.Custom
userLimit.ConditionIs64Bit(0) = False
userLimit.ConditionIsSingle(0) = False
userLimit.ConditionLogic(0) = Mpx.UserLimitLogic.Eq
userLimit.ConditionMask(0) = &hFFFFFFFF
userLimit.ConditionSrcAddress(0) = srcAddress
userLimit.ConditionValue(0) = 256
userLimit.GenerateEvent = True
userLimit.Action = Mpx.Action.None
userLimit.ConfigurationEnd() ' Writes configuration to the controller
|
Sample Application
C#
Syntax
uint[] ConditionMask;
Sample Code
| |
Mpx.UserLimit userLimit = controller.Axis[0].UserLimit[0];
int userBufferIndex = 0;
String UserBufferLocation = controller.Map.StringGet(Mpx.Map.UserBuffer, userBufferIndex);
userLimit.ConfigurationReset(); // Reset user limit configuration before configuring it
userLimit.ConfigurationBegin(); // Begin configuration
// Configure user limit
userLimit.TriggerType = Mpx.UserLimitTrigger.SingleCondition;
userLimit.ConditionType[0] = Mpx.UserLimitConditionType.Custom;
userLimit.ConditionIs64Bit[0] = false;
userLimit.ConditionIsSingle[0] = false;
userLimit.ConditionLogic[0] = Mpx.UserLimitLogic.Eq;
userLimit.ConditionMask[0] = 0xFFFFFFFF;
userLimit.ConditionSrcAddress[0] = srcAddress;
userLimit.ConditionValue[0] = 256;
userLimit.GenerateEvent = true;
userLimit.Action = Mpx.Action.None;
userLimit.ConfigurationEnd(); // Writes configuration to the controller
|
See Also
ConditionIs64Bit
ConditionIsSingle
ConditionLogic
ConditionSrcAddress
ConditionType
ConditionValue
Enumerations
UserLimitConditionType
|
