Scott Roy / OneWire
Embed: (wiki syntax)

« Back to documentation index

TransportSearchPersist Struct Reference

TransportSearchPersist Struct Reference

Persistant search structure Used to keep track of search state and results between executions of the search transport layer command. More...

#include <Transport.h>

Public Member Functions

void clear ()
 Clears existing search state and results in preparation for a new search.

Data Fields

OneWire_ROM rom
 Rom code result of previous search operation.
bool done
 Used to tell when to end a search sequence.

Detailed Description

Persistant search structure Used to keep track of search state and results between executions of the search transport layer command.

Definition at line 25 of file Transport.h.


Member Function Documentation

void clear (  )

Clears existing search state and results in preparation for a new search.

This will reset search progress to start a search sequence from the beginning

Note:
Search sequences should be restarted if a one-wire execution error occured as persistant state values might be invalid

Definition at line 74 of file Transport.cpp.


Field Documentation

bool done

Used to tell when to end a search sequence.

TRUE when the search has completed

FALSE when there are still rom codes left to search

Definition at line 40 of file Transport.h.

OneWire_ROM rom

Rom code result of previous search operation.

Note:
value should be ignored if a one-wire execution error occured

Definition at line 30 of file Transport.h.