tmc9660::TMC9660< CommType >::ReferenceSearch Struct Reference

Subsystem for executing a reference search (homing) routine. More...

#include <tmc9660.hpp>

Collaboration diagram for tmc9660::TMC9660< CommType >::ReferenceSearch:

Public Member Functions
bool	start () noexcept
	Start the reference search procedure.
bool	stop () noexcept
	Abort an ongoing reference search.
bool	getStatus (tmc9660::tmcl::ReferenceSearchStatus &status) noexcept
	Query the current reference search status code.

Private Member Functions
	ReferenceSearch (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

template<typename CommType>
struct tmc9660::TMC9660< CommType >::ReferenceSearch

Subsystem for executing a reference search (homing) routine.

Constructor & Destructor Documentation

ReferenceSearch()

template<typename CommType >

tmc9660::TMC9660< CommType >::ReferenceSearch::ReferenceSearch ( TMC9660 & parent )

inlineexplicitprivatenoexcept

Member Function Documentation

getStatus()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::ReferenceSearch::getStatus ( tmc9660::tmcl::ReferenceSearchStatus & status )

noexcept

Query the current reference search status code.

start()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::ReferenceSearch::start ( )

noexcept

Start the reference search procedure.

stop()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::ReferenceSearch::stop ( )

noexcept

Abort an ongoing reference search.

Friends And Related Symbol Documentation

TMC9660

template<typename CommType >

friend class TMC9660

friend

Member Data Documentation

driver

template<typename CommType >

TMC9660& tmc9660::TMC9660< CommType >::ReferenceSearch::driver

private

---

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

• tmc9660.hpp