apra::I2C_Message Class Reference

#include <I2CMessage.h>

Public Member Functions
	I2C_Message ()
virtual	~I2C_Message ()
void	configureWrite (vector< uint8_t > registerNumber, vector< uint8_t > data)
void	configureWrite (uint64_t registerNumber, uint64_t data, uint64_t registerSize, uint64_t dataSize)
void	configureRead (vector< uint8_t > registerNumber, uint64_t expectedDataSize)
void	configureRead (uint64_t registerNumber, uint64_t registerSize, uint64_t expectedDataSize)
void	configureReadWithComparison (vector< uint8_t > registerNumber, uint64_t expectedDataSize, const vector< uint8_t > dataCompare, bool compareEquals)
void	configureReadWithComparison (uint64_t registerNumber, uint64_t registerSize, uint64_t expectedDataSize, const uint64_t dataCompare, bool compareEquals)
void	addDelay (uint64_t delayInUsec)
void	setRetries (uint64_t retryCount)
uint64_t	getCombinedData ()
uint64_t	getCombinedRegister ()
uint64_t	getDataSize ()

Public Attributes
I2CError	m_error
I2C_MESSAGE_TYPE	m_type
vector< uint8_t >	m_registerNumber
vector< uint8_t >	m_data
vector< uint8_t >	m_compareData
uint64_t	m_retryCount
uint64_t	m_delayInUsec
uint64_t	m_retryDelayInUsec
bool	m_allowOtherProcessOnIdle

Protected Attributes
uint64_t	m_registerSize
uint64_t	m_dataSize

Detailed Description

Definition at line 25 of file I2CMessage.h.

Constructor & Destructor Documentation

I2C_Message()

apra::I2C_Message::I2C_Message

(

)

Definition at line 18 of file I2CMessage.cpp.

~I2C_Message()

apra::I2C_Message::~I2C_Message ( )

virtual

Definition at line 26 of file I2CMessage.cpp.

Member Function Documentation

addDelay()

void apra::I2C_Message::addDelay

(

uint64_t

delayInUsec

)

Definition at line 88 of file I2CMessage.cpp.

References m_delayInUsec.

configureRead() [1/2]

void apra::I2C_Message::configureRead	(	uint64_t	registerNumber,
		uint64_t	registerSize,
		uint64_t	expectedDataSize
	)

Definition at line 56 of file I2CMessage.cpp.

References apra::Utils::extractBytes(), apra::I2C_READ, m_dataSize, m_registerNumber, m_registerSize, and m_type.

configureRead() [2/2]

void apra::I2C_Message::configureRead	(	vector< uint8_t >	registerNumber,
		uint64_t	expectedDataSize
	)

Definition at line 48 of file I2CMessage.cpp.

References apra::I2C_READ, m_dataSize, m_registerNumber, m_registerSize, and m_type.

configureReadWithComparison() [1/2]

void apra::I2C_Message::configureReadWithComparison	(	uint64_t	registerNumber,
		uint64_t	registerSize,
		uint64_t	expectedDataSize,
		const uint64_t	dataCompare,
		bool	compareEquals
	)

Definition at line 76 of file I2CMessage.cpp.

References apra::Utils::extractBytes(), apra::I2C_READ_COMPARE_EQUAL, apra::I2C_READ_COMPARE_NOT_EQUAL, m_compareData, m_dataSize, m_registerNumber, m_registerSize, and m_type.

configureReadWithComparison() [2/2]

void apra::I2C_Message::configureReadWithComparison	(	vector< uint8_t >	registerNumber,
		uint64_t	expectedDataSize,
		const vector< uint8_t >	dataCompare,
		bool	compareEquals
	)

Definition at line 65 of file I2CMessage.cpp.

References apra::I2C_READ_COMPARE_EQUAL, apra::I2C_READ_COMPARE_NOT_EQUAL, m_compareData, m_dataSize, m_registerNumber, m_registerSize, and m_type.

configureWrite() [1/2]

void apra::I2C_Message::configureWrite	(	uint64_t	registerNumber,
		uint64_t	data,
		uint64_t	registerSize,
		uint64_t	dataSize
	)

Definition at line 39 of file I2CMessage.cpp.

References apra::Utils::extractBytes(), apra::I2C_WRITE, m_data, m_dataSize, m_registerNumber, m_registerSize, and m_type.

configureWrite() [2/2]

void apra::I2C_Message::configureWrite	(	vector< uint8_t >	registerNumber,
		vector< uint8_t >	data
	)

Definition at line 30 of file I2CMessage.cpp.

References apra::I2C_WRITE, m_data, m_dataSize, m_registerNumber, m_registerSize, and m_type.

getCombinedData()

uint64_t apra::I2C_Message::getCombinedData

(

)

Definition at line 103 of file I2CMessage.cpp.

References apra::Utils::combineBytes(), and m_data.

getCombinedRegister()

uint64_t apra::I2C_Message::getCombinedRegister

(

)

Definition at line 108 of file I2CMessage.cpp.

References apra::Utils::combineBytes(), and m_registerNumber.

getDataSize()

uint64_t apra::I2C_Message::getDataSize

(

)

Definition at line 113 of file I2CMessage.cpp.

References m_dataSize.

Referenced by apra::I2C_Interface::performCompareRead(), and apra::I2C_Interface::performRead().

setRetries()

void apra::I2C_Message::setRetries

(

uint64_t

retryCount

)

Definition at line 95 of file I2CMessage.cpp.

References m_retryCount.

Member Data Documentation

m_allowOtherProcessOnIdle

bool apra::I2C_Message::m_allowOtherProcessOnIdle

Definition at line 56 of file I2CMessage.h.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

m_compareData

vector<uint8_t> apra::I2C_Message::m_compareData

Definition at line 52 of file I2CMessage.h.

Referenced by configureReadWithComparison(), configureReadWithComparison(), and apra::I2C_Interface::performCompareRead().

m_data

vector<uint8_t> apra::I2C_Message::m_data

Definition at line 51 of file I2CMessage.h.

Referenced by configureWrite(), configureWrite(), getCombinedData(), apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

m_dataSize

uint64_t apra::I2C_Message::m_dataSize

protected

Definition at line 59 of file I2CMessage.h.

Referenced by configureRead(), configureRead(), configureReadWithComparison(), configureReadWithComparison(), configureWrite(), configureWrite(), and getDataSize().

m_delayInUsec

uint64_t apra::I2C_Message::m_delayInUsec

Definition at line 54 of file I2CMessage.h.

Referenced by addDelay().

m_error

I2CError apra::I2C_Message::m_error

Definition at line 48 of file I2CMessage.h.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

m_registerNumber

vector<uint8_t> apra::I2C_Message::m_registerNumber

Definition at line 50 of file I2CMessage.h.

Referenced by configureRead(), configureRead(), configureReadWithComparison(), configureReadWithComparison(), configureWrite(), configureWrite(), getCombinedRegister(), apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

m_registerSize

uint64_t apra::I2C_Message::m_registerSize

protected

Definition at line 58 of file I2CMessage.h.

Referenced by configureRead(), configureRead(), configureReadWithComparison(), configureReadWithComparison(), configureWrite(), and configureWrite().

m_retryCount

uint64_t apra::I2C_Message::m_retryCount

Definition at line 53 of file I2CMessage.h.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), apra::I2C_Interface::performWrite(), and setRetries().

m_retryDelayInUsec

uint64_t apra::I2C_Message::m_retryDelayInUsec

Definition at line 55 of file I2CMessage.h.

Referenced by apra::I2C_Interface::performCompareRead(), apra::I2C_Interface::performRead(), and apra::I2C_Interface::performWrite().

m_type

I2C_MESSAGE_TYPE apra::I2C_Message::m_type

Definition at line 49 of file I2CMessage.h.

Referenced by configureRead(), configureRead(), configureReadWithComparison(), configureReadWithComparison(), configureWrite(), and configureWrite().

---

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

• includes/models/I2CMessage.h
• src/models/I2CMessage.cpp