F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
Drv::InputI2cWriteReadPort Class Reference

#include <Drv/I2cDriverPorts/I2cWriteReadPortAc.hpp>

Inheritance diagram for Drv::InputI2cWriteReadPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE }
 
typedef Drv::I2cStatus(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, U32 addr, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)
 The port callback function type. More...
 

Public Member Functions

 InputI2cWriteReadPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
Drv::I2cStatus invoke (U32 addr, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (NATIVE_INT_TYPE portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected ()
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
- Protected Member Functions inherited from Fw::PortBase
 PortBase ()
 
virtual ~PortBase ()
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 
- Protected Attributes inherited from Fw::InputPortBase
PassiveComponentBasem_comp
 
NATIVE_INT_TYPE m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input I2cWriteRead port Write a set of bytes then read a set of bytes using the repeated start option

Definition at line 25 of file I2cWriteReadPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Drv::I2cStatus(* Drv::InputI2cWriteReadPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, U32 addr, Fw::Buffer &writeBuffer, Fw::Buffer &readBuffer)

The port callback function type.

Definition at line 50 of file I2cWriteReadPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 35 of file I2cWriteReadPortAc.hpp.

Constructor & Destructor Documentation

◆ InputI2cWriteReadPort()

Drv::InputI2cWriteReadPort::InputI2cWriteReadPort ( )

Constructor.

Definition at line 17 of file I2cWriteReadPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Drv::InputI2cWriteReadPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 31 of file I2cWriteReadPortAc.cpp.

◆ init()

void Drv::InputI2cWriteReadPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 25 of file I2cWriteReadPortAc.cpp.

◆ invoke()

Drv::I2cStatus Drv::InputI2cWriteReadPort::invoke ( U32  addr,
Fw::Buffer writeBuffer,
Fw::Buffer readBuffer 
)

Invoke a port interface.

Parameters
addrI2C slave device address
writeBufferBuffer to write data to the i2c device
readBufferBuffer to read back data from the i2c device, must set size when passing in read buffer

Definition at line 45 of file I2cWriteReadPortAc.cpp.


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