Driver::DIO::Out Class Reference

This class defines a generic interface for controlling a single Digital output signal. More...

Detailed Description

This class defines a generic interface for controlling a single Digital output signal.

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

#include <Out.h>

Public Member Functions
	Out (DriverDioOutPinConfig_T pinConfig, bool assertedHigh=true)
	Constructor.
bool	start (bool initialState)
	Starts the driver.
void	stop ()
	Stops the driver, places the output into a 'safe' state.
bool	getOutput () const
	Returns the current commanded state of the output DO signal.
void	setOutput (bool asserted)
	Sets the logical state of the output signal.
void	assertOutput ()
	Convenience method.
void	deassertOutput ()
	Convenience method.
bool	isAssertedHigh () const
	Returns true if the logical asserted state maps to a physical high signal.

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

Constructor & Destructor Documentation

Out()

Driver::DIO::Out::Out	(	DriverDioOutPinConfig_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

assertOutput()

void Driver::DIO::Out::assertOutput ( )

inline

Convenience method.

deassertOutput()

void Driver::DIO::Out::deassertOutput ( )

inline

Convenience method.

getOutput()

bool Driver::DIO::Out::getOutput

(

)

const

Returns the current commanded state of the output DO signal.

A true value indicates that the signal is asserted state

isAssertedHigh()

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

inline

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

setOutput()

void Driver::DIO::Out::setOutput

(

bool

asserted

)

Sets the logical state of the output signal.

start()

bool Driver::DIO::Out::start

(

bool

initialState

)

Starts the driver.

Returns false if an error was encountered

stop()

void Driver::DIO::Out::stop

(

)

Stops the driver, places the output into a 'safe' state.

The safe state is defined by the platform

Member Data Documentation

m_assertedHigh

bool Driver::DIO::Out::m_assertedHigh

protected

Polarity of the output ping.

m_pin

DriverDioOutPinConfig_T Driver::DIO::Out::m_pin

protected

PIN info.

m_started

bool Driver::DIO::Out::m_started

protected

Started flag.

---

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

• Driver/DIO/Out.h