DUDS
Distributed Update of Data from Something
duds::hardware::interface::PinConfiguration::PinSet Struct Reference

Holds configuration data for a single digital pin set. More...

#include <PinConfiguration.hpp>

Collaboration diagram for duds::hardware::interface::PinConfiguration::PinSet:

Public Member Functions

 PinSet ()=default
 
 PinSet (const std::pair< const std::string, boost::property_tree::ptree > &item, const PinConfiguration *pinconf)
 
PinConfiguration::Pins::index< index_seq >::type::iterator begin ()
 
PinConfiguration::Pins::index< index_seq >::type::iterator end ()
 
const PinConfiguration::Pins::index< index_seq >::type & seqIndex () const
 Convenience function that provides the sequential index for the sets's pins. More...
 

Public Attributes

DigitalPinSet dpSet
 The DigitalPinSet for this configuration. More...
 
Pins pins
 The pins used by this set. More...
 
std::string selName
 The name of an optional chip select that has been associated with this pin set. More...
 
PortusePort
 The port that will provide the pins for this set. More...
 

Detailed Description

Holds configuration data for a single digital pin set.

Definition at line 437 of file PinConfiguration.hpp.

Constructor & Destructor Documentation

◆ PinSet() [1/2]

duds::hardware::interface::PinConfiguration::PinSet::PinSet ( )
default

◆ PinSet() [2/2]

duds::hardware::interface::PinConfiguration::PinSet::PinSet ( const std::pair< const std::string, boost::property_tree::ptree > &  item,
const PinConfiguration pinconf 
)

Member Function Documentation

◆ begin()

PinConfiguration::Pins::index<index_seq>::type::iterator duds::hardware::interface::PinConfiguration::PinSet::begin ( )
inline

Definition at line 469 of file PinConfiguration.hpp.

◆ end()

PinConfiguration::Pins::index<index_seq>::type::iterator duds::hardware::interface::PinConfiguration::PinSet::end ( )
inline

Definition at line 472 of file PinConfiguration.hpp.

◆ seqIndex()

const PinConfiguration::Pins::index<index_seq>::type& duds::hardware::interface::PinConfiguration::PinSet::seqIndex ( ) const
inline

Convenience function that provides the sequential index for the sets's pins.

Definition at line 466 of file PinConfiguration.hpp.

Member Data Documentation

◆ dpSet

DigitalPinSet duds::hardware::interface::PinConfiguration::PinSet::dpSet

The DigitalPinSet for this configuration.

It is configured after the attachment of the DigitalPort that supplies the pins used by the set.

Definition at line 442 of file PinConfiguration.hpp.

◆ pins

Pins duds::hardware::interface::PinConfiguration::PinSet::pins

The pins used by this set.

Definition at line 446 of file PinConfiguration.hpp.

◆ selName

std::string duds::hardware::interface::PinConfiguration::PinSet::selName

The name of an optional chip select that has been associated with this pin set.

If there is no associated chip select, this string will be empty.

Definition at line 452 of file PinConfiguration.hpp.

◆ usePort

Port* duds::hardware::interface::PinConfiguration::PinSet::usePort

The port that will provide the pins for this set.

Definition at line 456 of file PinConfiguration.hpp.


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