The protocol is used to communicate an I2C master transaction. More...

#include <Imt.Base.Dff.ActiveParts.STM32F103HD/Protocols/I2CMasterTransactionProtocol.h>

Inheritance diagram for imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol:

Public Member Functions
	I2CMasterTransactionProtocol (void)
	Default Constructor. More...

	I2CMasterTransactionProtocol (const uint8_t address, const uint32_t transactionId, const uint8_t numberOfDataOperations, const uint16_t writeTransactionFlags, const uint8_t data[DATA_SIZE])
	Custom Constructor. More...

	I2CMasterTransactionProtocol (const I2CMasterTransactionProtocol &other)
	Copy constructor. More...

	I2CMasterTransactionProtocol (imt::base::core::serialization::Deserializer &deserializer)
	Constructor from deserializer. More...

virtual	~I2CMasterTransactionProtocol (void)
	Destructor. More...

I2CMasterTransactionProtocol &	operator= (const I2CMasterTransactionProtocol &other)
	Assignment operator. More...

bool	operator== (const I2CMasterTransactionProtocol &right) const
	Equality operator. More...

bool	operator!= (const I2CMasterTransactionProtocol &right) const
	Inequality operator. More...

virtual void	deserialize (imt::base::core::serialization::Deserializer &deserializer)

virtual void	serialize (imt::base::core::serialization::Serializer &serializer) const

void	setAddress (const uint8_t address)
	Sets 7-bit slave address. More...

uint8_t	getAddress (void) const
	Gets 7-bit slave address. More...

void	setTransactionId (const uint32_t transactionId)
	Sets Transaction identification. More...

uint32_t	getTransactionId (void) const
	Gets Transaction identification. More...

void	setNumberOfDataOperations (const uint8_t numberOfDataOperations)
	Sets Configures how many data operations should be done with this transaction. More...

uint8_t	getNumberOfDataOperations (void) const
	Gets Configures how many data operations should be done with this transaction. More...

void	setWriteTransactionFlags (const uint16_t writeTransactionFlags)
	Sets Bit flag for each data operation. More...

uint16_t	getWriteTransactionFlags (void) const
	Gets Bit flag for each data operation. More...

void	setData (const uint8_t data[DATA_SIZE])
	Sets Contains the data to write or the read data according to writeTransactionFlags configuration. More...

void	getData (uint8_t data[DATA_SIZE]) const
	Gets Contains the data to write or the read data according to writeTransactionFlags configuration. More...

Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual	~SerializableIfc (void)
	Destructor. More...

Static Public Attributes
static const uint32_t	DATA_SIZE = 16U
	Array size constants. More...

Detailed Description

The protocol is used to communicate an I2C master transaction.

Constructor & Destructor Documentation

◆ I2CMasterTransactionProtocol() [1/4]

imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::I2CMasterTransactionProtocol ( void )

explicit

Default Constructor.

◆ I2CMasterTransactionProtocol() [2/4]

imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::I2CMasterTransactionProtocol	(	const uint8_t	address,
		const uint32_t	transactionId,
		const uint8_t	numberOfDataOperations,
		const uint16_t	writeTransactionFlags,
		const uint8_t	data[DATA_SIZE]
	)

explicit

Custom Constructor.

◆ I2CMasterTransactionProtocol() [3/4]

imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::I2CMasterTransactionProtocol ( const I2CMasterTransactionProtocol & other )

Copy constructor.

◆ I2CMasterTransactionProtocol() [4/4]

imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::I2CMasterTransactionProtocol ( imt::base::core::serialization::Deserializer & deserializer )

explicit

Constructor from deserializer.

◆ ~I2CMasterTransactionProtocol()

virtual imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::~I2CMasterTransactionProtocol ( void )

virtual

Destructor.

Member Function Documentation

◆ deserialize()

virtual void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::deserialize ( imt::base::core::serialization::Deserializer & deserializer )

virtual

See also: SerializableIfc

Implements imt::base::core::serialization::SerializableIfc.

◆ getAddress()

uint8_t imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::getAddress ( void ) const

Gets 7-bit slave address.

◆ getData()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::getData ( uint8_t data[DATA_SIZE] ) const

Gets Contains the data to write or the read data according to writeTransactionFlags configuration.

◆ getNumberOfDataOperations()

uint8_t imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::getNumberOfDataOperations ( void ) const

Gets Configures how many data operations should be done with this transaction.

◆ getTransactionId()

uint32_t imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::getTransactionId ( void ) const

Gets Transaction identification.

◆ getWriteTransactionFlags()

uint16_t imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::getWriteTransactionFlags ( void ) const

Gets Bit flag for each data operation.

If write(true) or read (false) operation.

◆ operator!=()

bool imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::operator!= ( const I2CMasterTransactionProtocol & right ) const

Inequality operator.

◆ operator=()

I2CMasterTransactionProtocol& imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::operator= ( const I2CMasterTransactionProtocol & other )

Assignment operator.

◆ operator==()

bool imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::operator== ( const I2CMasterTransactionProtocol & right ) const

Equality operator.

◆ serialize()

virtual void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::serialize ( imt::base::core::serialization::Serializer & serializer ) const

virtual

See also: SerializableIfc

Implements imt::base::core::serialization::SerializableIfc.

◆ setAddress()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::setAddress ( const uint8_t address )

Sets 7-bit slave address.

◆ setData()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::setData ( const uint8_t data[DATA_SIZE] )

Sets Contains the data to write or the read data according to writeTransactionFlags configuration.

◆ setNumberOfDataOperations()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::setNumberOfDataOperations ( const uint8_t numberOfDataOperations )

Sets Configures how many data operations should be done with this transaction.

◆ setTransactionId()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::setTransactionId ( const uint32_t transactionId )

Sets Transaction identification.

◆ setWriteTransactionFlags()

void imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::setWriteTransactionFlags ( const uint16_t writeTransactionFlags )

Sets Bit flag for each data operation.

If write(true) or read (false) operation.

Member Data Documentation

◆ DATA_SIZE

const uint32_t imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol::DATA_SIZE = 16U

static

Array size constants.

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

D:/_Work/10/s/Imt.Base/Imt.Base.Dff.ActiveParts.STM32F103HD/Protocols/I2CMasterTransactionProtocol.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ I2CMasterTransactionProtocol() [1/4]

◆ I2CMasterTransactionProtocol() [2/4]

◆ I2CMasterTransactionProtocol() [3/4]

◆ I2CMasterTransactionProtocol() [4/4]

◆ ~I2CMasterTransactionProtocol()

Member Function Documentation

◆ deserialize()

◆ getAddress()

◆ getData()

◆ getNumberOfDataOperations()

◆ getTransactionId()

◆ getWriteTransactionFlags()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ serialize()

◆ setAddress()

◆ setData()

◆ setNumberOfDataOperations()

◆ setTransactionId()

◆ setWriteTransactionFlags()

Member Data Documentation

◆ DATA_SIZE