![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Generic framing component using FramingProtocol implementation for actual framing. More...
#include <Svc/Framer/Framer.hpp>
Public Member Functions | |
Framer (const char *const compName) | |
void | setup (FramingProtocol &protocol) |
Setup this component with a supplied framing protocol. | |
~Framer () | |
![]() | |
void | init (FwEnumStoreType instance=0) |
Initialize FramerComponentBase object. | |
Fw::InputBufferSendPort * | get_bufferIn_InputPort (FwIndexType portNum) |
Fw::InputComPort * | get_comIn_InputPort (FwIndexType portNum) |
Fw::InputSuccessConditionPort * | get_comStatusIn_InputPort (FwIndexType portNum) |
void | set_bufferDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port) |
Connect port to bufferDeallocate[portNum]. | |
void | set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port) |
Connect port to comStatusOut[portNum]. | |
void | set_framedAllocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port) |
Connect port to framedAllocate[portNum]. | |
void | set_framedOut_OutputPort (FwIndexType portNum, Drv::InputByteStreamSendPort *port) |
Connect port to framedOut[portNum]. | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. | |
U32 | getIdBase () const |
![]() | |
virtual | ~FramingProtocolInterface () |
Additional Inherited Members | |
![]() | |
enum | { NUM_BUFFERIN_INPUT_PORTS = 1 , NUM_COMIN_INPUT_PORTS = 1 , NUM_COMSTATUSIN_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_COMSTATUSOUT_OUTPUT_PORTS = 1 , NUM_FRAMEDALLOCATE_OUTPUT_PORTS = 1 , NUM_FRAMEDOUT_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
![]() | |
FramerComponentBase (const char *compName="") | |
Construct FramerComponentBase object. | |
virtual | ~FramerComponentBase () |
Destroy FramerComponentBase object. | |
FwIndexType | getNum_bufferIn_InputPorts () const |
FwIndexType | getNum_comIn_InputPorts () const |
FwIndexType | getNum_comStatusIn_InputPorts () const |
FwIndexType | getNum_bufferDeallocate_OutputPorts () const |
FwIndexType | getNum_comStatusOut_OutputPorts () const |
FwIndexType | getNum_framedAllocate_OutputPorts () const |
FwIndexType | getNum_framedOut_OutputPorts () const |
bool | isConnected_bufferDeallocate_OutputPort (FwIndexType portNum) |
bool | isConnected_comStatusOut_OutputPort (FwIndexType portNum) |
bool | isConnected_framedAllocate_OutputPort (FwIndexType portNum) |
bool | isConnected_framedOut_OutputPort (FwIndexType portNum) |
void | bufferIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port bufferIn. | |
void | comIn_handlerBase (FwIndexType portNum, Fw::ComBuffer &data, U32 context) |
Handler base-class function for input port comIn. | |
void | comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition) |
Handler base-class function for input port comStatusIn. | |
void | bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port bufferDeallocate. | |
void | comStatusOut_out (FwIndexType portNum, Fw::Success &condition) |
Invoke output port comStatusOut. | |
Fw::Buffer | framedAllocate_out (FwIndexType portNum, U32 size) |
Invoke output port framedAllocate. | |
Drv::SendStatus | framedOut_out (FwIndexType portNum, Fw::Buffer &sendBuffer) |
Invoke output port framedOut. | |
virtual void | lock () |
Lock the guarded mutex. | |
virtual void | unLock () |
Unlock the guarded mutex. | |
![]() | |
PassiveComponentBase (const char *name) | |
Named constructor. | |
virtual | ~PassiveComponentBase () |
Destructor. | |
void | init (NATIVE_INT_TYPE instance) |
Initialization function. | |
NATIVE_INT_TYPE | getInstance () const |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. | |
virtual | ~ObjBase () |
Destructor. | |
void | init () |
Object initializer. | |
Generic framing component using FramingProtocol implementation for actual framing.
Framing component used to take Com and File packets and frame serialize them using a framing protocol specified in a FramingProtocol instance. The instance must be supplied using the setup
method.
Using this component, projects can implement and supply a fresh FramingProtocol implementation without changing the reference topology.
Definition at line 31 of file Framer.hpp.
Svc::Framer::Framer | ( | const char *const | compName | ) |
Construct object Framer
compName | The component name |
Definition at line 24 of file Framer.cpp.
Svc::Framer::~Framer | ( | ) |
Destroy object Framer
Definition at line 27 of file Framer.cpp.
void Svc::Framer::setup | ( | FramingProtocol & | protocol | ) |
Setup this component with a supplied framing protocol.
protocol | Protocol used in framing |
Definition at line 29 of file Framer.cpp.