imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol Class Reference

Used to signalize the status of an I2C interrupt based transfer. More...

#include <Imt.Base.Dff.ActiveParts.AM3354/I2C/I2CIrqTransactionStatusProtocol.h>

Inheritance diagram for imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol:

Public Types
enum	TransactionState { TransactionState_Success , TransactionState_Failed }
	Defines the transaction states. More...
enum	TransactionFailedReason { TransactionFailedReason_None , TransactionFailedReason_AckFailure , TransactionFailedReason_ArbitrationLost }
	Defines the reasons why a transaction could have failed. More...

Public Member Functions
	I2CIrqTransactionStatusProtocol (const TransactionState state, const TransactionFailedReason failedReason=TransactionFailedReason_None)
	Constructor. More...
	I2CIrqTransactionStatusProtocol (imt::base::core::serialization::Deserializer &deserializer)
	Constructor from deserializer. More...
virtual	~I2CIrqTransactionStatusProtocol (void)
	Destructor. More...
virtual void	deserialize (imt::base::core::serialization::Deserializer &deserializer)
virtual void	serialize (imt::base::core::serialization::Serializer &serializer) const
TransactionState	getTransactionState (void) const
	Returns the transaction state. More...
TransactionFailedReason	getTransactionFailedReason (void) const
	Returns the reason why the transaction was failed. More...
Public Member Functions inherited from imt::base::core::serialization::SerializableIfc
virtual	~SerializableIfc (void)
	Destructor. More...

Detailed Description

Used to signalize the status of an I2C interrupt based transfer.

Member Enumeration Documentation

TransactionFailedReason

enum imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::TransactionFailedReason

Defines the reasons why a transaction could have failed.

Enumerator
TransactionFailedReason_None
TransactionFailedReason_AckFailure
TransactionFailedReason_ArbitrationLost

TransactionState

enum imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::TransactionState

Defines the transaction states.

Enumerator
TransactionState_Success
TransactionState_Failed

Constructor & Destructor Documentation

I2CIrqTransactionStatusProtocol() [1/2]

imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::I2CIrqTransactionStatusProtocol ( const TransactionState  state, const TransactionFailedReason  failedReason = TransactionFailedReason_None  )

explicit

Constructor.

Parameters

state	Transaction state.
failedReason	The reason why a transaction could have failed (optional).

I2CIrqTransactionStatusProtocol() [2/2]

imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::I2CIrqTransactionStatusProtocol ( imt::base::core::serialization::Deserializer &  deserializer )

explicit

Constructor from deserializer.

~I2CIrqTransactionStatusProtocol()

virtual imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::~I2CIrqTransactionStatusProtocol ( void  )

virtual

Destructor.

Member Function Documentation

deserialize()

virtual void imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::deserialize ( imt::base::core::serialization::Deserializer &  deserializer )

virtual

See also

SerializableIfc

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

getTransactionFailedReason()

TransactionFailedReason imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::getTransactionFailedReason

(

void

)

const

Returns the reason why the transaction was failed.

Returns

imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::TransactionFailedReason

getTransactionState()

TransactionState imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::getTransactionState

(

void

)

const

Returns the transaction state.

Returns

imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::TransactionState

serialize()

virtual void imt::base::dff::activeparts::am3354::I2CIrqTransactionStatusProtocol::serialize ( imt::base::core::serialization::Serializer &  serializer ) const

virtual

See also

SerializableIfc

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

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.Dff.ActiveParts.AM3354/I2C/I2CIrqTransactionStatusProtocol.h