Driver::DIO::In Class Reference

This class defines a generic interface for sampling a single Digital Input signal. More...

Detailed Description

This class defines a generic interface for sampling a single Digital Input signal.

The 'asserted' Pin state maps to the signal being logically high.

#include <In.h>

Public Member Functions
	In (DriverDioInPinConfig_T pinConfig, bool assertedHigh=true)
	Constructor.
bool	start ()
	Starts the driver.
void	stop ()
	Stops the driver.
bool	sample () const
	Returns the current input value.
bool	isAssertedHigh () const
	Returns true if the logical asserted state maps to a physical high signal.

Protected Attributes
DriverDioInPinConfig_T	m_pin
	PIN info.
bool	m_assertedHigh
	Polarity of the output ping.
bool	m_started
	Started flag.

Constructor & Destructor Documentation

In()

Driver::DIO::In::In	(	DriverDioInPinConfig_T	pinConfig,
		bool	assertedHigh = true
	)

Constructor.

Note: the 'pinConfig' struct MUST stay in scope as long as the driver is in scope.

Member Function Documentation

isAssertedHigh()

bool Driver::DIO::In::isAssertedHigh ( ) const

inline

Returns true if the logical asserted state maps to a physical high signal.

sample()

bool Driver::DIO::In::sample

(

)

const

Returns the current input value.

A true value indicates that the signal is asserted state

start()

bool Driver::DIO::In::start

(

)

Starts the driver.

Returns false if an error was encountered

stop()

void Driver::DIO::In::stop

(

)

Stops the driver.

Member Data Documentation

m_assertedHigh

bool Driver::DIO::In::m_assertedHigh

protected

Polarity of the output ping.

m_pin

DriverDioInPinConfig_T Driver::DIO::In::m_pin

protected

PIN info.

m_started

bool Driver::DIO::In::m_started

protected

Started flag.

---

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

• Driver/DIO/In.h