Dataflow Runtime API  2.7.4.0
Public Member Functions | Static Public Attributes | List of all members
imt::base::dff::activeparts::stm32f103hd::protocol::I2CMasterTransactionProtocol Class Reference

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:
imt::base::core::serialization::SerializableIfc

Public Member Functions

 I2CMasterTransactionProtocol (void)
 Default Constructor.
 
 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.
 
 I2CMasterTransactionProtocol (const I2CMasterTransactionProtocol &other)
 Copy constructor.
 
 I2CMasterTransactionProtocol (imt::base::core::serialization::Deserializer &deserializer)
 Constructor from deserializer.
 
virtual ~I2CMasterTransactionProtocol (void)
 Destructor.
 
I2CMasterTransactionProtocoloperator= (const I2CMasterTransactionProtocol &other)
 Assignment operator.
 
bool operator== (const I2CMasterTransactionProtocol &right) const
 Equality operator.
 
bool operator!= (const I2CMasterTransactionProtocol &right) const
 Inequality operator.
 
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.
 
uint8_t getAddress (void) const
 Gets 7-bit slave address.
 
void setTransactionId (const uint32_t transactionId)
 Sets Transaction identification.
 
uint32_t getTransactionId (void) const
 Gets Transaction identification.
 
void setNumberOfDataOperations (const uint8_t numberOfDataOperations)
 Sets Configures how many data operations should be done with this transaction.
 
uint8_t getNumberOfDataOperations (void) const
 Gets Configures how many data operations should be done with this transaction.
 
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.
 
void getData (uint8_t data[DATA_SIZE]) const
 Gets Contains the data to write or the read data according to writeTransactionFlags configuration.
 
- Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual ~SerializableIfc (void)
 Destructor.
 

Static Public Attributes

static const uint32_t DATA_SIZE = 16U
 Array size constants.
 

Detailed Description

The protocol is used to communicate an I2C master transaction.

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.

◆ 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.

◆ 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.

◆ 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.


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