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

Input I2c port. More...

#include <Drv/I2cDriverPorts/I2cPortAc.hpp>

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

Public Types

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

Public Member Functions

 InputI2cPort ()
 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 &serBuffer)
 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 I2c port.

Definition at line 24 of file I2cPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Drv::I2cStatus(* Drv::InputI2cPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, U32 addr, Fw::Buffer &serBuffer)

The port callback function type.

Definition at line 48 of file I2cPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 34 of file I2cPortAc.hpp.

Constructor & Destructor Documentation

◆ InputI2cPort()

Drv::InputI2cPort::InputI2cPort ( )

Constructor.

Definition at line 17 of file I2cPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 31 of file I2cPortAc.cpp.

◆ init()

void Drv::InputI2cPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 25 of file I2cPortAc.cpp.

◆ invoke()

Drv::I2cStatus Drv::InputI2cPort::invoke ( U32  addr,
Fw::Buffer serBuffer 
)

Invoke a port interface.

Parameters
addrI2C slave device address
serBufferBuffer with data to read/write to/from

Definition at line 45 of file I2cPortAc.cpp.


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