Class LogOptions

Class Documentation

class LogOptions

This class contains options that specify the data to collect during a data logging operation.

Public Functions

LogOptions()

Public Members

unsigned char commandPos

If set to 1, the Pos Cmd data will be collected. If set to 0, this data will not be collected.

unsigned char feedbackPos

If set to 1, the Actual Pos data will be collected. If set to 0, this data will not be collected.

unsigned char compCommandPos

If set to 1, the Comp Pos Cmd data will be collected. If set to 0, this data will not be collected.

unsigned char compFeedbackPos

If set to 1, the Comp Actual Pos data will be collected. If set to 0, this data will not be collected.

unsigned char encoderCommandPos

If set to 1, the Encoder Command data will be collected. If set to 0, this data will not be collected.

unsigned char encoderFeedbackPos

If set to 1, the Encoder Feedback data will be collected. If set to 0, this data will not be collected.

unsigned char commandVelocity

If set to 1, the Velocity Cmd data will be collected. If set to 0, this data will not be collected.

unsigned char feedbackVelocity

If set to 1, the Actual Velocity data will be collected. If set to 0, this data will not be collected.

unsigned char encoderCommandVelocity

If set to 1, the velocity command data sent to the servo will be collected. If set to 0, this data will not be collected.

unsigned char encoderFeedbackVelocity

If set to 1, the velocity feedback data received from the servo will be collected. If set to 0, this data will not be collected.

unsigned char commandTrq

If set to 1, the Torque Cmd data will be collected. If set to 0, this data will not be collected.

unsigned char feedbackTrq

If set to 1, the Actual Torque data will be collected. If set to 0, this data will not be collected.

unsigned char encoderCommandTrq

If set to 1, the torque command data sent to the servo will be collected. If set to 0, this data will not be collected.

unsigned char encoderFeedbackTrq

If set to 1, the torque feedback data received from the servo will be collected. If set to 0, this data will not be collected.

unsigned char followingError

If set to 1, the Actual Following Error data will be collected. If set to 0, this data will not be collected.

unsigned char homeOffset

If set to 1, the home offset data will be collected. If set to 0, this data will not be collected.

unsigned char inPosFlag

If set to 1, the In Pos data will be collected. If set to 0, this data will not be collected.

unsigned char inPosFlag2

If set to 1, the In Pos 2 data will be collected. If set to 0, this data will not be collected.

unsigned char inPosFlag3

If set to 1, the In Pos 3 data will be collected. If set to 0, this data will not be collected.

unsigned char inPosFlag4

If set to 1, the In Pos 4 data will be collected. If set to 0, this data will not be collected.

unsigned char inPosFlag5

If set to 1, the In Pos 5 data will be collected. If set to 0, this data will not be collected.

unsigned char commandDistributionEndFlag

If set to 1, the Cmd Distribution End status data will be collected. If set to 0, this data will not be collected.

unsigned char posSetFlag

If set to 1, the Pos Set status data will be collected. If set to 0, this data will not be collected.

unsigned char delayedPosSetFlag

If set to 1, the Delayed Pos Set status data will be collected. If set to 0, this data will not be collected.

unsigned char opState

If set to 1, the Op State status data will be collected. If set to 0, this data will not be collected.

unsigned char detailOpState

If set to 1, the Detail Op State status data will be collected. If set to 0, this data will not be collected.

unsigned char userOffsetCommandPos

If set to 1, the User Offset Pos Cmd status data will be collected. If set to 0, this data will not be collected.

unsigned char userOffsetFeedbackPos

If set to 1, the User Offset Actual Pos status data will be collected. If set to 0, this data will not be collected.

unsigned char axisCommandMode

If set to 1, the Axis Command Mode status data will be collected. If set to 0, this data will not be collected.

unsigned char axisCommandModeFeedback

If set to 1, the command mode of the axis returned by the servo is logged. This is the command mode that the servo is actually operating in compared to the requested command mode that is returned by the Axis Command Mode status. If set to 0, this data will not be collected.

unsigned char followingErrorAlarm

If set to 1, the Following Error Alarm will be collected. If set to 0, this data will not be collected.

unsigned char ampAlarm

If set to 1, the Amp Alarm will be collected. If set to 0, this data will not be collected.

unsigned char ampAlarmCode

If set to 1, the Amp Alarm Code will be collected. If set to 0, this data will not be collected.

unsigned char servoOn

If set to 1, the Servo On will be collected. If set to 0, this data will not be collected.

unsigned char servoOffline

If set to 1, the Servo Offline will be collected. If set to 0, this data will not be collected.

unsigned char positiveLS

If set to 1, the Positive LS will be collected. If set to 0, this data will not be collected.

unsigned char negativeLS

If set to 1, the Negative LS will be collected. If set to 0, this data will not be collected.

unsigned char nearPositiveLS

If set to 1, the Near Positive LS will be collected. If set to 0, this data will not be collected.

unsigned char nearNegativeLS

If set to 1, the Near Negative LS will be collected. If set to 0, this data will not be collected.

unsigned char externalPositiveLS

If set to 1, the External Positive LS will be collected. If set to 0, this data will not be collected.

unsigned char externalNegativeLS

If set to 1, the External Negative LS will be collected. If set to 0, this data will not be collected.

unsigned char positiveSoftLimit

If set to 1, the Positive Soft Limit will be collected. If set to 0, this data will not be collected.

unsigned char negativeSoftLimit

If set to 1, the Negative Soft Limit will be collected. If set to 0, this data will not be collected.

unsigned char homeState

If set to 1, the Home State will be collected. If set to 0, this data will not be collected.

unsigned char homeSwitch

If set to 1, the Home Switch will be collected. If set to 0, this data will not be collected.

unsigned char homeDone

If set to 1, the Home Done will be collected. If set to 0, this data will not be collected.

unsigned char triggerOnCommandChange

If set to 0, data logging will begin when the StartLog function is called. If set to 1, data logging will not immediately begin after the StartLog function is called. Instead, data logging will begin the next time the command of one of the logged axes changes. Position command mode axes will start data logging when the command position changes, Velocity command mode axes will start data logging when the command velocity changes, and Torque command mode axes will start data logging when the command torque changes.

unsigned char triggerOnEvent

If set to 0, data logging will begin when the StartLog function is called. If set to 1, data logging will not immediately begin after the StartLog function is called. Instead, data logging will begin the next time that the condition of the event specified by the triggerEventID becomes true.

unsigned int triggerEventID

When triggerOnEvent is set to 1, this value specifies the ID of the event to trigger data logging.