OneWire Library for Arduino  version: 1.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
OneWire::ForwardSearchRomIterator Class Reference

Iterates through all 1-Wire devices sequentially using the search procedure. More...

#include <RomIterator.h>

Inheritance diagram for OneWire::ForwardSearchRomIterator:
OneWire::ForwardRomIterator OneWire::RomIterator

Public Member Functions

 ForwardSearchRomIterator (OneWireMaster &master)
 
const RomIdselectedDevice () const
 ROM ID of the currently selected device. More...
 
virtual bool lastDevice () const
 Indicates that current device is the last. More...
 
virtual OneWireMaster::CmdResult selectFirstDevice ()
 Select the first device in the sequence. More...
 
virtual OneWireMaster::CmdResult selectNextDevice ()
 Select the next device in the sequence. More...
 
virtual OneWireMaster::CmdResult reselectCurrentDevice ()
 Reselect the current device for an additional operation. More...
 
OneWireMaster::CmdResult selectFirstDeviceInFamily (uint8_t familyCode)
 
OneWireMaster::CmdResult selectNextFamilyDevice ()
 
- Public Member Functions inherited from OneWire::ForwardRomIterator
 ForwardRomIterator (OneWireMaster &master)
 
- Public Member Functions inherited from OneWire::RomIterator
virtual ~RomIterator ()
 
OneWireMastermaster () const
 The 1-Wire master used to issue ROM commands. More...
 

Protected Attributes

RomCommands::SearchState searchState
 

Additional Inherited Members

- Protected Member Functions inherited from OneWire::RomIterator
 RomIterator (OneWireMaster &master)
 

Detailed Description

Iterates through all 1-Wire devices sequentially using the search procedure.

Constructor & Destructor Documentation

OneWire::ForwardSearchRomIterator::ForwardSearchRomIterator ( OneWireMaster master)
inline
Parameters
master1-Wire master to use to issue ROM commands.

Member Function Documentation

bool ForwardSearchRomIterator::lastDevice ( ) const
virtual

Indicates that current device is the last.

Implements OneWire::ForwardRomIterator.

OneWireMaster::CmdResult ForwardSearchRomIterator::reselectCurrentDevice ( )
virtual

Reselect the current device for an additional operation.

Implements OneWire::ForwardRomIterator.

const RomId& OneWire::ForwardSearchRomIterator::selectedDevice ( ) const
inline

ROM ID of the currently selected device.

OneWireMaster::CmdResult ForwardSearchRomIterator::selectFirstDevice ( )
virtual

Select the first device in the sequence.

Implements OneWire::ForwardRomIterator.

OneWireMaster::CmdResult ForwardSearchRomIterator::selectFirstDeviceInFamily ( uint8_t  familyCode)

Select the first device in the sequence beginning with the given family.

Parameters
familyCodeFamily code to select.
OneWireMaster::CmdResult ForwardSearchRomIterator::selectNextDevice ( )
virtual

Select the next device in the sequence.

Implements OneWire::ForwardRomIterator.

OneWireMaster::CmdResult ForwardSearchRomIterator::selectNextFamilyDevice ( )

Select the first device in the next sequential family skipping all remaining devices in the current family.

Member Data Documentation

RomCommands::SearchState OneWire::ForwardSearchRomIterator::searchState
protected

The documentation for this class was generated from the following files: