vortex::motor::ApplyResult Struct Reference

What ApplyParameterImage() did. More...

#include <Tmc9660DriveObservability.h>

Public Member Functions
bool	ok () const noexcept

Public Attributes
uint16_t	entries {0}
	Entries in the image.
uint16_t	written {0}
	SAPs sent (after the differential skip)
uint16_t	skipped {0}
	Already equal on the chip.
uint16_t	rejected {0}
	SAPs the chip refused (status != REPLY_OK)
uint16_t	mismatches {0}
	Read back different from the image.
Param	first_bad {}
	First rejected or mismatched parameter.
ReplyCode	first_bad_status {ReplyCode::REPLY_OK}
uint32_t	first_bad_readback {0}

Detailed Description

What ApplyParameterImage() did.

Member Function Documentation

ok()

bool vortex::motor::ApplyResult::ok ( ) const

inlinenoexcept

Member Data Documentation

entries

uint16_t vortex::motor::ApplyResult::entries {0}

Entries in the image.

first_bad

Param vortex::motor::ApplyResult::first_bad {}

First rejected or mismatched parameter.

first_bad_readback

uint32_t vortex::motor::ApplyResult::first_bad_readback {0}

first_bad_status

ReplyCode vortex::motor::ApplyResult::first_bad_status {ReplyCode::REPLY_OK}

mismatches

uint16_t vortex::motor::ApplyResult::mismatches {0}

Read back different from the image.

rejected

uint16_t vortex::motor::ApplyResult::rejected {0}

SAPs the chip refused (status != REPLY_OK)

skipped

uint16_t vortex::motor::ApplyResult::skipped {0}

Already equal on the chip.

written

uint16_t vortex::motor::ApplyResult::written {0}

SAPs sent (after the differential skip)

---

The documentation for this struct was generated from the following file:

• Tmc9660DriveObservability.h