MPIMapSymbolType

Declaration

typedef enum MPIMapSymbolType
{
    MPIMapSymbolTypeINVALID = -1,


    MPIMapSymbolTypeAXIS_COMMAND_POSITION,
    MPIMapSymbolTypeAXIS_ACTUAL_POSITION,
    MPIMapSymbolTypeAXIS_CALCULATOR_COMMAND_POSITION,
    MPIMapSymbolTypeAXIS_CALCULATOR_ACTUAL_POSITION,
    MPIMapSymbolTypeAXIS_POSITION_ERROR,
    MPIMapSymbolTypeAXIS_COMMAND_VELOCITY,
    MPIMapSymbolTypeAXIS_ACTUAL_VELOCITY,
    MPIMapSymbolTypeAXIS_COMMAND_ACCEL,
    MPIMapSymbolTypeAXIS_COMMAND_JERK,


    MPIMapSymbolTypeFILTER_OUTPUT,


    MPIMapSymbolTypeMOTOR_FEEDBACK_PRIMARY,
    MPIMapSymbolTypeMOTOR_FEEDBACK_SECONDARY,
    MPIMapSymbolTypeMOTOR_FEEDBACK_PRIMARY_DELTA,
    MPIMapSymbolTypeMOTOR_FEEDBACK_SECONDARY_DELTA,
    MPIMapSymbolTypeMOTOR_STATUS_OUTPUT,


    MPIMapSymbolTypeAXIS_STATUS,
    MPIMapSymbolTypeMOTION_STATUS,
    MPIMapSymbolTypeMOTOR_STATUS,
    MPIMapSymbolTypeRECORDER_STATUS,
    MPIMapSymbolTypeSEQUENCE_STATUS,
    MPIMapSymbolTypeSYNQNET_STATUS,
    MPIMapSymbolTypeSQNODE_STATUS,


    MPIMapSymbolTypeMOTOR_DEDICATED_IN,
    MPIMapSymbolTypeMOTOR_DEDICATED_OUT,
    MPIMapSymbolTypeMOTOR_GENERAL_IN,
    MPIMapSymbolTypeMOTOR_GENERAL_OUT,


    MPIMapSymbolTypeCONTROL_DIGITAL_IN,
    MPIMapSymbolTypeCONTROL_DIGITAL_OUT,


    MPIMapSymbolTypeSQNODE_DIGITAL_IN,
    MPIMapSymbolTypeSQNODE_DIGITAL_OUT,


    MPIMapSymbolTypeSQNODE_ANALOG_IN,
    MPIMapSymbolTypeSQNODE_ANALOG_OUT,


    MPIMapSymbolTypeAXIS_CURRENT_FRAME_INDEX,
    MPIMapSymbolTypeAXIS_LOAD_FRAME_INDEX,


    MPIMapSymbolTypeSAMPLE_COUNTER,
    MPIMapSymbolTypeBACKGROUND_CYCLE,
    MPIMapSymbolTypeBACKGROUND_COUNT_DELTA,


    MPIMapSymbolTypeGATE,


    MPIMapSymbolTypeDRIVE_MONITOR_A,
    MPIMapSymbolTypeDRIVE_MONITOR_B,
    MPIMapSymbolTypeDRIVE_MONITOR_C,


    MPIMapSymbolTypeNULL_INPUT,
    MPIMapSymbolTypeNULL_OUTPUT,


    MPIMapSymbolTypeUSER_BUFFER,
    MPIMapSymbolTypeVOLATILE_BUFFER,


    MPIMapSymbolTypeCAPTURE_STATE,
    MPIMapSymbolTypeSYNQNET_STATE,
    MPIMapSymbolTypeMOTION_STATE,
    MPIMapSymbolTypeAXIS_STATE,
    MPIMapSymbolTypeRECORDER_STATE,
    MPIMapSymbolTypeUSER_LIMIT_STATE,


    MPIMapSymbolTypeEND,
    MPIMapSymbolTypeFIRST = MPIMapSymbolTypeINVALID + 1,
    MPIMapSymbolTypeCOUNT = MPIMapSymbolTypeEND - MPIMapSymbolTypeFIRST


} MPIMapSymbolType;

Required Header: map.h

Change History: Added in 04.00.

Description

MPIMapSymbolType is an enumeration representing commonly referenced memory locations on the controller. MPIMapSymbolType enumeration values usually need additional indices to fully represent a particular location. The table below lists the number of indices required, the maning of each index, and the description for each MPIMapSymbolType enumeration value.

Enumeration Value
Numbers of Associated Indices
Index[0]
Index[1]
Index[2]
Description
AXIS_COMMAND_POSITION
1
Axis Number
Command Position
AXIS_ACTUAL_POSITION
1
Axis Number
Actual Position
AXIS_CALCULATOR_COMMAND_POSITION
1
Axis Number
Trajectory Calculator Command Position
AXIS_CALCULATOR_ACTUAL_POSITION
1
Axis Number
Trajectory Calculator Actual Position
AXIS_POSITION_ERROR
1
Axis Number
Position Error
AXIS_COMMAND_VELOCITY
1
Axis Number
Actual Velocity
AXIS_COMMAND_ACCEL
1
Axis Number
Command Acceleration
AXIS_COMMAND_JERK
1
Axis Number
Command Jerk
FILTER_OUTPUT
1
Filter Number
Output Demand
MOTOR_FEEDBACK_PRIMARY
1
Motor Number
Primary Feedback
MOTOR_FEEDBACK_SECONDARY
1
Motor Number
Auxiliary Feedback
MOTOR_FEEDBACK_PRIMARY_DELTA
1
Motor Number
Primary Feedback Delta
(velocity)
MOTOR_FEEDBACK_SECONDARY_DELTA
1
Motor Number
Auxiliary Feedback Delta (velocity)
MOTOR_STATUS_OUTPUT
1
Motor Number
Reserved
AXIS_STATUS
1
Axis Number
Axis Status
MOTION_STATUS
1
Motion Number
Motion Status
MOTOR_STATUS
1
Motor Number
Motor Status
RECORDER_STATUS
1
Recorder Number
Recorder Status
SEQUENCE_STATUS
1
Sequence Number
Sequence Status
SYNQNET_STATUS
1
SynqNet Number
SynqNet Status
SQNODE_STATUS
2
Motor Number
Node Number
SynqNet Node Status
MOTOR_DEDICATED_IN
2
Motor Number
Bit Number
Motor Dedicated In
MOTOR_DEDICATED_OUT
2
Motor Number
Bit Number
Motor Dedicated Out
MOTOR_GENERAL_IN
2
Motor Number
Bit Number
Motor General Input
MOTOR_GENERAL_OUT
2
Motor Number
Bit Number
Motor General Output
CONTROL_DIGITAL_IN
1
Bit Number
Control Digital Input
CONTROL_DIGITAL_OUT
1
Bit Number
Control Digital Output
SQNODE_DIGITAL_IN
3
SynqNet Number
Node Number
Bit Number
SynqNet Node Digital Input
SQNODE_DIGITAL_OUT
3
SynqNet Number
Node Number
Bit Number
SynqNet Node Digital Output
SQNODE_ANALOG_IN
3
SynqNet Number
Node Number
Channel
SynqNet Node Analog Input
SQNODE_ANALOG_OUT
3
SynqNet Number
Node Number
Channel
SynqNet Node Analog Output
AXIS_CURRENT_FRAME_INDEX
1
Axis Number
Current executing frame index
AXIS_LOAD_FRAME_INDEX
1
Axis Number
Axis frame load index
SAMPLE_COUNTER
0
Sample Counter
BACKGROUND_CYCLE
0
Background Cycle
BACKGROUND_COUNT_DELTA
0
Background Cycle Count Delta
GATE
1
Motion Gate
DRIVE_MONITOR_A
1
Monitor A
DRIVE_MONITOR_B
1
Monitor B
DRIVE_MONITOR_C
1
Monitor C
NULL_INPUT
0
Null Input
NULL_OUTPUT
0
Null Output
USER_BUFFER
1
User Buffer
VOLATILE_BUFFER
1
Volatile Buffer
CAPTURE_STATE
1
Capture State
SYNQNET_STATE
1
SynqNet State
MOTION_STATE
1
Motion State
AXIS_STATE
1
Axis State
RECORDER_STATE
1
Recorder State
USER_LIMIT_STATE
1
User Limit State

Sample Code

MPIMap       mpiMap;
MPIMapSymbol data;
MPIMapPtr    info;
MPI_RESULT   returnValue;


/* ... */


/* Obtain information about axis 3's actual position. */
data.location = MPIMapSymbolTypeACTUAL_POSITION;
data.index[0] = 3;


returnValue = mpiMapSymbolToPtr(mpiMap, &data, &info);


/* info.dataType holds axis 3's data type. */


/* info.ptr      holds a host pointer to axis 3's memory on the controller */
/* info.ptr.v    may be used to configure a data recorder trace */


/* info.mask     should be 0xFFFFFFFFFFFFFFFF (as actual positions are not bitmasks) */
/*               info.mask will only have one bit set for digital i/o though, and    */
/*               info.mask will likely only have 16 bits set for analog i/o.         */

See Also

mpiMapSymbolToPtr | mpiMapPtrToSymbol | MPIMapSymbol