Holds configuration data for a single digital I/O pin. More...

#include <PinConfiguration.hpp>

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

Public Member Functions
	Pin ()

	Pin (const std::pair< const std::string, boost::property_tree::ptree > &item, Port *owner)
	Create a new Pin with parsed pin subtree data stored in a property tree. More...

void	parse (const std::pair< const std::string, boost::property_tree::ptree > &item, Port *owner)
	Parse pin subtree data stored in a property tree. More...

Public Attributes
unsigned int	gid
	Assigned global ID. More...

std::string	name
	Optional pin name. More...

Port *	parent
	The Port object that supplies the pin. More...

unsigned int	pid
	Port ID. More...

Static Public Attributes
static constexpr unsigned int	NoIdSpecified = -2
	No ID was specified, but there may still be a pin depending on the context. More...

static constexpr unsigned int	NoPin = -1
	There is explicitly no pin connected to the corresponding global ID. More...

Detailed Description

Holds configuration data for a single digital I/O pin.

Definition at line 193 of file PinConfiguration.hpp.

Constructor & Destructor Documentation

◆ Pin() [1/2]

duds::hardware::interface::PinConfiguration::Pin::Pin ( )

Definition at line 20 of file PinConfiguration.cpp.

◆ Pin() [2/2]

duds::hardware::interface::PinConfiguration::Pin::Pin	(	const std::pair< const std::string, boost::property_tree::ptree > &	item,
		Port *	owner
	)

Create a new Pin with parsed pin subtree data stored in a property tree.

Exceptions

PortBadPinIdError A pin ID could not be parsed.

Definition at line 22 of file PinConfiguration.cpp.

Member Function Documentation

◆ parse()

void duds::hardware::interface::PinConfiguration::Pin::parse	(	const std::pair< const std::string, boost::property_tree::ptree > &	item,
		Port *	owner
	)

Parse pin subtree data stored in a property tree.

Exceptions

PortBadPinIdError A pin ID could not be parsed.

Definition at line 47 of file PinConfiguration.cpp.

Referenced by Pin().

Member Data Documentation

◆ gid

unsigned int duds::hardware::interface::PinConfiguration::Pin::gid

Assigned global ID.

Definition at line 205 of file PinConfiguration.hpp.

Referenced by duds::hardware::interface::PinConfiguration::attachPort(), duds::hardware::interface::PinConfiguration::ChipSel::ChipSel(), parse(), and duds::hardware::interface::ParseState().

◆ name

std::string duds::hardware::interface::PinConfiguration::Pin::name

Optional pin name.

Definition at line 201 of file PinConfiguration.hpp.

Referenced by duds::hardware::interface::PinConfiguration::ChipSel::ChipSel(), and parse().

◆ NoIdSpecified

constexpr unsigned int duds::hardware::interface::PinConfiguration::Pin::NoIdSpecified = -2

static

No ID was specified, but there may still be a pin depending on the context.

Examples:: pinconfig.cpp.

Definition at line 218 of file PinConfiguration.hpp.

◆ NoPin

constexpr unsigned int duds::hardware::interface::PinConfiguration::Pin::NoPin = -1

static

There is explicitly no pin connected to the corresponding global ID.

Examples:: pinconfig.cpp.

Definition at line 213 of file PinConfiguration.hpp.

Referenced by duds::hardware::interface::PinConfiguration::attachPort(), and duds::hardware::interface::ParsePinId().

◆ parent

Port* duds::hardware::interface::PinConfiguration::Pin::parent

The Port object that supplies the pin.

Definition at line 197 of file PinConfiguration.hpp.

Referenced by duds::hardware::interface::PinConfiguration::attachPort(), duds::hardware::interface::PinConfiguration::ChipSel::ChipSel(), parse(), and duds::hardware::interface::ParseState().

◆ pid

unsigned int duds::hardware::interface::PinConfiguration::Pin::pid

Port ID.

Definition at line 209 of file PinConfiguration.hpp.

Referenced by duds::hardware::interface::PinConfiguration::attachPort(), duds::hardware::interface::PinConfiguration::ChipSel::ChipSel(), and parse().

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

Public Member Functions

Public Attributes

Static Public Attributes