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

#include <Fw/Dp/DpGetPortAc.hpp>

Inheritance diagram for Fw::OutputDpGetPort:
Fw::OutputPortBase Fw::PortBase Fw::ObjBase

Public Member Functions

 OutputDpGetPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallPort (InputDpGetPort *callPort)
 Register an input port. More...
 
Fw::Success invoke (FwDpIdType id, FwSizeType dataSize, Fw::Buffer &buffer) const
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected () const
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::OutputPortBase
 OutputPortBase ()
 
virtual ~OutputPortBase ()
 
void init () override
 
- 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::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Output DpGet port Port for synchronously getting a data product buffer Returns the status

On return, buffer should be set to a valid buffer large enough to hold a data product packet with the requested data size (if status is SUCCESS) or an invalid buffer (if status is FAILURE).

Definition at line 117 of file DpGetPortAc.hpp.

Constructor & Destructor Documentation

◆ OutputDpGetPort()

Fw::OutputDpGetPort::OutputDpGetPort ( )

Constructor.

Definition at line 81 of file DpGetPortAc.cpp.

Member Function Documentation

◆ addCallPort()

void Fw::OutputDpGetPort::addCallPort ( InputDpGetPort callPort)

Register an input port.

Parameters
callPortThe input port

Definition at line 95 of file DpGetPortAc.cpp.

◆ init()

void Fw::OutputDpGetPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::PortBase.

Definition at line 89 of file DpGetPortAc.cpp.

◆ invoke()

Fw::Success Fw::OutputDpGetPort::invoke ( FwDpIdType  id,
FwSizeType  dataSize,
Fw::Buffer buffer 
) const

Invoke a port interface.

Parameters
idThe container ID (input)
dataSizeThe data size of the requested buffer (input)
bufferThe buffer (output)

Definition at line 108 of file DpGetPortAc.cpp.


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