A partial DigitalPort implementation for ports where the configuration of each pin is independent of the configuration of all other pins. More...

#include <DigitalPortIndependentPins.hpp>

Inheritance diagram for duds::hardware::interface::DigitalPortIndependentPins:

[legend]

Collaboration diagram for duds::hardware::interface::DigitalPortIndependentPins:

[legend]

Public Member Functions
virtual bool	independentConfig () const
	Always true. More...

virtual bool	independentConfig (unsigned int, const DigitalPinConfig &, const DigitalPinConfig &) const
	Always true. More...

Public Member Functions inherited from duds::hardware::interface::DigitalPort
virtual	~DigitalPort ()
	Derived classes should call shutdown() early in their destructors. More...

void	access (const unsigned int pins, const unsigned int len, std::unique_ptr< DigitalPinAccess > acc)
	Obtain access objects to use a set of pins. More...

template<std::size_t Len>
void	access (const unsigned int pins[Len], std::unique_ptr< DigitalPinAccess > acc[Len])

std::unique_ptr< DigitalPinAccess >	access (const unsigned int pin)

void	access (const unsigned int pins, const unsigned int len, DigitalPinAccess acc)
	Obtain access objects to use a set of pins. More...

void	access (const std::vector< unsigned int > &pins, DigitalPinAccess *acc)

template<std::size_t alen, std::size_t plen>
void	access (const unsigned int pins[plen], DigitalPinAccess acc[alen])
	This is a nice idea that may fail at compile time. More...

void	access (const unsigned int *pins, const unsigned int len, DigitalPinSetAccess &acc)
	Obtain access objects to use a set of pins. More...

void	access (const unsigned int begin, const unsigned int end, DigitalPinSetAccess &acc)

void	access (const std::vector< unsigned int > &pins, DigitalPinSetAccess &acc)

std::unique_ptr< DigitalPinSetAccess >	access (const std::vector< unsigned int > &pins)

template<class InputIter >
void	access (const InputIter &begin, const InputIter &end, DigitalPinSetAccess &acc)

DigitalPinCap	capabilities (unsigned int globalPinId) const
	Returns the capabilities of a pin. More...

std::vector< DigitalPinCap >	capabilities () const
	Returns the capabilities of all pins in the port. More...

std::vector< DigitalPinCap >	capabilities (const std::vector< unsigned int > &pvec) const
	Returns the capabilities of all the pins requested by global ID. More...

std::vector< DigitalPinCap >	capabilitiesLocalIds (const std::vector< unsigned int > &pvec) const
	Returns the capabilities of all the pins requested by local ID. More...

DigitalPinConfig	configuration (unsigned int globalPinId) const
	Returns the current configuration of a pin. More...

std::vector< DigitalPinConfig >	configuration () const
	Returns the configuration of all pins in the port. More...

std::vector< DigitalPinConfig >	configuration (const std::vector< unsigned int > &pvec) const
	Returns the configuration of all the pins requested by global ID. More...

std::vector< DigitalPinConfig >	configurationLocalIds (const std::vector< unsigned int > &pvec) const
	Returns the configuration of all the pins requested by local ID. More...

bool	exists (unsigned int gid) const
	Returns true if the pin exists in this port. More...

unsigned int	globalId (unsigned int localId) const
	Returns the global ID for a pin given the local ID. More...

std::vector< unsigned int >	globalIds (const std::vector< unsigned int > &localIds) const
	Converts the provided local pin IDs to global pin IDs. More...

unsigned int	localId (unsigned int globalId) const
	Returns the local ID for a pin given the global ID. More...

std::vector< unsigned int >	localIds (const std::vector< unsigned int > &globalIds) const
	Converts the provided global pin IDs to local pin IDs. More...

unsigned int	offset () const
	Returns the offset for the port's pins. More...

void	poll ()

void	pollInput ()

void	pollSignal ()

DigitalPinRejectedConfiguration::Reason	proposeConfig (unsigned int gid, DigitalPinConfig &pconf, DigitalPinConfig &iconf) const
	Proposes a configuration change for a single pin. More...

DigitalPinRejectedConfiguration::Reason	proposeConfig (unsigned int gid, DigitalPinConfig &pconf) const
	Proposes a configuration change for a single pin from the port's current configuration. More...

bool	proposeConfig (const std::vector< unsigned int > &globalPinIds, std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const

bool	proposeConfig (const std::vector< unsigned int > &pins, std::vector< DigitalPinConfig > &propConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const

bool	proposeConfigLocalIds (const std::vector< unsigned int > &localPinIds, std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const

bool	proposeConfigLocalIds (const std::vector< unsigned int > &pins, std::vector< DigitalPinConfig > &propConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const

bool	proposeFullConfig (std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const

virtual bool	simultaneousOperations () const =0
	True if the implementation supports operating on multiple pins simultaneously. More...

unsigned int	size () const
	The maximum number of pins on the port. More...

Protected Member Functions
	DigitalPortIndependentPins (unsigned int numpins, unsigned int firstid)

virtual void	configurePort (const std::vector< DigitalPinConfig > &cfgs, DigitalPinAccessBase::PortData *pdata)
	Changes the hardware configuration for the whole port by calling configurePort(const DigitalPinConfig &, unsigned int, DigitalPinAccessBase::PortData *) for each pin. More...

virtual void	configurePort (unsigned int localPinId, const DigitalPinConfig &cfg, DigitalPinAccessBase::PortData *pdata)=0
	Changes the hardware configuration for a single pin. More...

virtual DigitalPinRejectedConfiguration::Reason	proposeConfigImpl (unsigned int gid, DigitalPinConfig &pconf, DigitalPinConfig &iconf) const
	Considers the proposed configuration for one pin. More...

virtual bool	proposeConfigImpl (const std::vector< unsigned int > &localPinIds, std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const
	Considers the proposed configuration one pin at a time in the order specified in pins. More...

virtual bool	proposeFullConfigImpl (std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, std::function< void(DigitalPinRejectedConfiguration::Reason)> insertReason=std::function< void(DigitalPinRejectedConfiguration::Reason)>()) const
	Considers the proposed configuration one pin at a time for all pins in the port. More...

Protected Member Functions inherited from duds::hardware::interface::DigitalPort
	DigitalPort (unsigned int numpins, unsigned int firstid)
	Initializes internal data. More...

std::vector< DigitalPinCap >	capabilities (const std::vector< unsigned int > &pvec, bool global) const

const DigitalPinConfig &	configRef (unsigned int localPinId) const
	Returns a reference to a pin's configuration on behalf of an access object. More...

std::vector< DigitalPinConfig >	configuration (const std::vector< unsigned int > &pvec, bool global) const

std::vector< DigitalPinConfig >	configurationImpl () const
	Returns the configuration of all pins in the port. More...

bool	input (unsigned int gid, DigitalPinAccessBase::PortData *pdata)
	Does error checking in advance of calling inputImpl(unsigned int) to read the input of the given pin. More...

std::vector< bool >	input (const std::vector< unsigned int > &pvec, DigitalPinAccessBase::PortData *pdata)
	Does error checking in advance of calling inputImpl(const std::vector<unsigned int> &) to read the input of a set of pins. More...

virtual bool	inputImpl (unsigned int gid, DigitalPinAccessBase::PortData *pdata)=0
	Reads input from the given pin. More...

virtual std::vector< bool >	inputImpl (const std::vector< unsigned int > &pvec, DigitalPinAccessBase::PortData *pdata)
	Reads input from the requested pins. More...

virtual void	madeAccess (DigitalPinAccess &acc)
	Called after a new access object is made to allow a port implementation to take further action. More...

virtual void	madeAccess (DigitalPinSetAccess &acc)
	Called after a new access object is made to allow a port implementation to take further action. More...

DigitalPinConfig	modifyConfig (unsigned int globalPinId, const DigitalPinConfig &cfg, DigitalPinAccessBase::PortData *pdata)
	Modifies the configuration of a single pin with an independent configuration. More...

void	modifyConfig (std::vector< DigitalPinConfig > &cfgs, DigitalPinAccessBase::PortData *pdata)
	Modifies the configuration of multiple pins. More...

void	modifyConfig (const std::vector< unsigned int > &pvec, std::vector< DigitalPinConfig > &cfgs, DigitalPinAccessBase::PortData *pdata)

void	modifyFullConfig (std::vector< DigitalPinConfig > &propConf, std::vector< DigitalPinConfig > &initConf, DigitalPinAccessBase::PortData *pdata)
	Does the work of the modifyConfig() functions in the case that the whole port configuration must be considered for possible changes. More...

void	output (unsigned int gid, bool state, DigitalPinAccessBase::PortData *pdata)
	Does error checking in advance of calling outputImpl(unsigned int, bool) to change the output of the given pin. More...

void	output (const std::vector< unsigned int > &pvec, const std::vector< bool > &state, DigitalPinAccessBase::PortData *pdata)
	Does error checking in advance of calling outputImpl(const std::vector<unsigned int> &,const std::vector<bool> &) to change the output of a set of pins. More...

virtual void	outputImpl (unsigned int lid, bool state, DigitalPinAccessBase::PortData *pdata)=0
	Changes the output state of the given pin. More...

virtual void	outputImpl (const std::vector< unsigned int > &pvec, const std::vector< bool > &state, DigitalPinAccessBase::PortData *pdata)
	Changes the outputs of several pins. More...

virtual void	retiredAccess (const DigitalPinAccess &acc) noexcept
	Called just before an access object is retired to allow a port implementation to take further action. More...

virtual void	retiredAccess (const DigitalPinSetAccess &acc) noexcept
	Called just before an access object is retired to allow a port implementation to take further action. More...

void	shutdown ()
	Waits for access to all pins so that any user of access objects may finish with their operation, then destroys all pin data and awakens threads waiting on access, but they will not receive access. More...

Additional Inherited Members
Protected Types inherited from duds::hardware::interface::DigitalPort
typedef std::vector< PinEntry >	PinVector

Static Protected Member Functions inherited from duds::hardware::interface::DigitalPort
static DigitalPinAccessBase::PortData &	portData (const DigitalPinAccessBase &acc)
	Returns a reference to the port specific data in the given DigitalPinAccessBase object. More...

template<typename T >
static void	portDataPtr (const DigitalPinAccessBase &acc, T **ptr)
	Provides a pointer to type T stored in the port specific data of the given DigitalPinAccessBase object. More...

Protected Attributes inherited from duds::hardware::interface::DigitalPort
PinVector	pins
	Data on each pin handled by the port. More...

Detailed Description

A partial DigitalPort implementation for ports where the configuration of each pin is independent of the configuration of all other pins.

Author: Jeff Jackowski

Definition at line 22 of file DigitalPortIndependentPins.hpp.

Constructor & Destructor Documentation

◆ DigitalPortIndependentPins()

duds::hardware::interface::DigitalPortIndependentPins::DigitalPortIndependentPins	(	unsigned int	numpins,
		unsigned int	firstid
	)

inlineprotected

Definition at line 37 of file DigitalPortIndependentPins.hpp.

Member Function Documentation

◆ configurePort() [1/2]

void duds::hardware::interface::DigitalPortIndependentPins::configurePort	(	const std::vector< DigitalPinConfig > &	cfgs,
		DigitalPinAccessBase::PortData *	pdata
	)

protectedvirtual

Changes the hardware configuration for the whole port by calling configurePort(const DigitalPinConfig &, unsigned int, DigitalPinAccessBase::PortData *) for each pin.

This makes sense for ports that do not support simultaneous operations, ports that do not benifit from them for configuration, and for tesing an implementation prior to fully implementing simultaneous operations.

Parameters

cfgs	The new configuration. The indices are the local pin IDs. The size must match the size of pins.
pdata	A pointer to the port specific data stored in the corresponding access object for the pins.

Implements duds::hardware::interface::DigitalPort.

Definition at line 167 of file DigitalPortIndependentPins.cpp.

Referenced by DigitalPortIndependentPins().

◆ configurePort() [2/2]

virtual void duds::hardware::interface::DigitalPortIndependentPins::configurePort	(	unsigned int	localPinId,
		const DigitalPinConfig &	cfg,
		DigitalPinAccessBase::PortData *	pdata
	)

protectedpure virtual

Changes the hardware configuration for a single pin.

If this function does not throw, its caller will record the configuration change inside pins. It is only called after error checking is performed on its parameters.

Parameters

cfg	The new configuration.
localPinId	The local ID for the pin to modify.
pdata	A pointer to the port specific data stored in the corresponding access object for the pin.

Implements duds::hardware::interface::DigitalPort.

Implemented in duds::hardware::interface::linux::GpioDevPort, duds::hardware::interface::linux::SysFsPort, and duds::hardware::interface::test::VirtualPort.

◆ independentConfig() [1/2]

bool duds::hardware::interface::DigitalPortIndependentPins::independentConfig ( ) const

virtual

Always true.

Implements duds::hardware::interface::DigitalPort.

Definition at line 14 of file DigitalPortIndependentPins.cpp.

◆ independentConfig() [2/2]

bool duds::hardware::interface::DigitalPortIndependentPins::independentConfig	(	unsigned int	,
		const DigitalPinConfig &	,
		const DigitalPinConfig &
	)		const

virtual

Always true.

Implements duds::hardware::interface::DigitalPort.

Definition at line 18 of file DigitalPortIndependentPins.cpp.

◆ proposeConfigImpl() [1/2]

DigitalPinRejectedConfiguration::Reason duds::hardware::interface::DigitalPortIndependentPins::proposeConfigImpl	(	unsigned int	gid,
		DigitalPinConfig &	pconf,
		DigitalPinConfig &	iconf
	)		const

protectedvirtual

Considers the proposed configuration for one pin.

Port implementations do not have to redefine this function, but may if advantageous.

Implements duds::hardware::interface::DigitalPort.

Definition at line 147 of file DigitalPortIndependentPins.cpp.

Referenced by DigitalPortIndependentPins().

◆ proposeConfigImpl() [2/2]

bool duds::hardware::interface::DigitalPortIndependentPins::proposeConfigImpl	(	const std::vector< unsigned int > &	localPinIds,
		std::vector< DigitalPinConfig > &	propConf,
		std::vector< DigitalPinConfig > &	initConf,
		std::function< void(DigitalPinRejectedConfiguration::Reason)>	insertReason = `std::function<void(DigitalPinRejectedConfiguration::Reason)>()`
	)		const

protectedvirtual

Considers the proposed configuration one pin at a time in the order specified in pins.

Port implementations do not have to redefine this function, but may if advantageous.

Implements duds::hardware::interface::DigitalPort.

Definition at line 27 of file DigitalPortIndependentPins.cpp.

◆ proposeFullConfigImpl()

bool duds::hardware::interface::DigitalPortIndependentPins::proposeFullConfigImpl	(	std::vector< DigitalPinConfig > &	propConf,
		std::vector< DigitalPinConfig > &	initConf,
		std::function< void(DigitalPinRejectedConfiguration::Reason)>	insertReason = `std::function<void(DigitalPinRejectedConfiguration::Reason)>()`
	)		const

protectedvirtual

Considers the proposed configuration one pin at a time for all pins in the port.

Port implementations do not have to redefine this function, but may if advantageous.

Implements duds::hardware::interface::DigitalPort.

Definition at line 93 of file DigitalPortIndependentPins.cpp.

Referenced by DigitalPortIndependentPins().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DigitalPortIndependentPins()

Member Function Documentation

◆ configurePort() [1/2]

◆ configurePort() [2/2]

◆ independentConfig() [1/2]

◆ independentConfig() [2/2]

◆ proposeConfigImpl() [1/2]

◆ proposeConfigImpl() [2/2]

◆ proposeFullConfigImpl()