imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc Class Reference

Interface of I2C transaction queue. More...

#include <Imt.Base.Dff.ActiveParts.STM32F103HD/I2C/I2CTransactionQueueIfc.h>

Inheritance diagram for imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc:

Public Member Functions
virtual	~I2CTransactionQueueIfc (void)
	Destructor. More...
virtual void	setRemainingDataOperations (const uint8_t numberOfDataOperations)=0
	Set the remaining data operations to complete on the current transaction item. More...
virtual uint8_t	getRemainingDataOperations (void) const =0
	Return the remaining data operations to complete on the current transaction item. More...
virtual void	setDataOperationProcessed (void)=0
	Mark a data operations as completed. More...
virtual void	push (const imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol &newValue)=0
	Add a value to the buffer (overwrite oldest if full). More...
virtual imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol &	top (void)=0
	The value on the top of the buffer. More...
virtual imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol	pop (void)=0
	The value on the top of the buffer. More...
virtual bool	isEmpty (void) const =0
	Returns true if no transaction item is on the queue. More...
virtual bool	isFull (void) const =0
	Returns true if the queue is full. More...
virtual uint16_t	getSizeUsed (void) const =0
	Get the number of items in the buffer. More...

Detailed Description

Interface of I2C transaction queue.

Constructor & Destructor Documentation

~I2CTransactionQueueIfc()

virtual imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::~I2CTransactionQueueIfc ( void  )

inlinevirtual

Destructor.

Member Function Documentation

getRemainingDataOperations()

virtual uint8_t imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::getRemainingDataOperations ( void  ) const

pure virtual

Return the remaining data operations to complete on the current transaction item.

Returns

Number of remaining data operations to complete.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

getSizeUsed()

virtual uint16_t imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::getSizeUsed ( void  ) const

pure virtual

Get the number of items in the buffer.

Returns

Number of items in the buffer.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

isEmpty()

virtual bool imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::isEmpty ( void  ) const

pure virtual

Returns true if no transaction item is on the queue.

Returns

True if no transaction item is on the queue.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

isFull()

virtual bool imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::isFull ( void  ) const

pure virtual

Returns true if the queue is full.

Returns

True if the queue is full.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

pop()

virtual imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::pop ( void  )

pure virtual

The value on the top of the buffer.

The value will be removed from the buffer. There is no check if the value is valid. To check this use isEmpty.

Returns

The oldest value which is on the top of the buffer.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

push()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::push ( const imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol &  newValue )

pure virtual

Add a value to the buffer (overwrite oldest if full).

Parameters

newValue

The value to be added.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

setDataOperationProcessed()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::setDataOperationProcessed ( void  )

pure virtual

Mark a data operations as completed.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

setRemainingDataOperations()

virtual void imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::setRemainingDataOperations ( const uint8_t  numberOfDataOperations )

pure virtual

Set the remaining data operations to complete on the current transaction item.

Parameters

numberOfDataOperations

Number of remaining data operations.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

top()

virtual imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol& imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueueIfc::top ( void  )

pure virtual

The value on the top of the buffer.

The value will not be removed from the buffer. There is no check if the value is valid. To check this use isEmpty.

Returns

The oldest value which is on the top of the buffer.

Implemented in imt::base::dff::activeparts::stm32f103hd::i2c::I2CTransactionQueue< TransactionQueueSize >.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.Dff.ActiveParts.STM32F103HD/I2C/I2CTransactionQueueIfc.h