mpiUserLimitConfigDefault
Declaration
MPI_DECL1 MPI_RESULT MPI_DECL2 mpiUserLimitConfigDefault(MPIUserLimitConfig* config);
Required Header: stdmpi.h
Change History: Added in 04.00.
Description
mpiUserLimitConfigDefault sets the structure pointed to by config to the default user limit configuration.
Recommendation:
Use mpiUserLimitConfigDefault to initialize the MPIUserLimitConfig data structure when setting a new configuration where most parameters need to be set.
Use mpiUserLimitGet to initialize the MPIUserLimitConfig data structure when the existing configuration on the controller is similar to the new configuration and changing only the required parameters.
| config | A pointer to the configuration structure where the configuration information is to be written. |
|---|
Sample Code
MPI_RESULT returnValue;
MPIUserLimit userLimit;
MPIUserLimitConfig userEventConfig;
/* ... */
returnValue = mpiUserLimitConfigDefault(&userEventConfig);
msgCHECK(returnValue);
/* Generate an event */
userEventConfig.generateEvent = TRUE;
/* Use a single condition */
userEventConfig.trigger.type = MPIUserLimitTriggerTypeSINGLE_CONDITION;
/* Trigger when axis 5's actual position exceeds 300000 */
userEventConfig.trigger.condition[0].type = MPIUserLimitConditionTypeAXIS_ACTUAL_POSITION;
userEventConfig.trigger.condition[0].data.axisActualPosition.axisNumber = 5;
userEventConfig.trigger.condition[0].data.axisActualPosition.position = 300000;
userEventConfig.trigger.condition[0].data.axisActualPosition.logic = MPIUserLimitLogicGT;
/* Setup output block: Set a SynqNet I/O Node's analog output. */
/* Set node 3's analog channel 7 to a value of 1234 */
userEventConfig.output.type = MPIUserLimitOutputTypeSQNODE_ANALOG_OUT;
userEventConfig.output.data.sqNodeAnalogOut.nodeNumber = 3;
userEventConfig.output.data.sqNodeAnalogOut.channel = 7;
userEventConfig.output.data.sqNodeAnalogOut.newValue.i16 = 1234;
returnValue = mpiUserLimitConfigSet(userLimit, &userEventConfig);
msgCHECK(returnValue);
See Also
MPIUserLimitConfig | mpiUserLimitConfigGet | mpiUserLimitConfigSet