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

#include <Svc/FprimeDeframer/FprimeDeframer.hpp>

Inheritance diagram for Svc::FprimeDeframer:
Svc::FprimeDeframerComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 FprimeDeframer (const char *const compName)
 Construct FprimeDeframer object. More...
 
 ~FprimeDeframer ()
 Destroy FprimeDeframer object. More...
 
- Public Member Functions inherited from Svc::FprimeDeframerComponentBase
void init (FwEnumStoreType instance=0)
 Initialize FprimeDeframerComponentBase object. More...
 
Svc::InputComDataWithContextPortget_framedIn_InputPort (FwIndexType portNum)
 
void set_logOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to logOut[portNum]. More...
 
void set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to timeCaller[portNum]. More...
 
void set_bufferDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferDeallocate[portNum]. More...
 
void set_deframedOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to deframedOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::FprimeDeframerComponentBase
enum  { NUM_FRAMEDIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_LOGOUT_OUTPUT_PORTS = 1, NUM_LOGTEXTOUT_OUTPUT_PORTS = 1, NUM_TIMECALLER_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1, NUM_DEFRAMEDOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { EVENTID_INVALIDBUFFERRECEIVED = 0x0, EVENTID_INVALIDSTARTWORD = 0x1, EVENTID_INVALIDLENGTHRECEIVED = 0x2, EVENTID_INVALIDCHECKSUM = 0x3 }
 Event IDs. More...
 
- Protected Member Functions inherited from Svc::FprimeDeframerComponentBase
 FprimeDeframerComponentBase (const char *compName="")
 Construct FprimeDeframerComponentBase object. More...
 
virtual ~FprimeDeframerComponentBase ()
 Destroy FprimeDeframerComponentBase object. More...
 
FwIndexType getNum_framedIn_InputPorts () const
 
FwIndexType getNum_logOut_OutputPorts () const
 
FwIndexType getNum_timeCaller_OutputPorts () const
 
FwIndexType getNum_bufferDeallocate_OutputPorts () const
 
FwIndexType getNum_deframedOut_OutputPorts () const
 
bool isConnected_logOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
bool isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_deframedOut_OutputPort (FwIndexType portNum)
 
void framedIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port framedIn. More...
 
void bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferDeallocate. More...
 
void deframedOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port deframedOut. More...
 
void log_WARNING_HI_InvalidBufferReceived () const
 
void log_WARNING_HI_InvalidStartWord () const
 
void log_WARNING_HI_InvalidLengthReceived () const
 
void log_WARNING_HI_InvalidChecksum () const
 
Fw::Time getTime () const
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (FwEnumStoreType instance)
 Initialization function. More...
 
FwEnumStoreType getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 

Detailed Description

Definition at line 15 of file FprimeDeframer.hpp.

Constructor & Destructor Documentation

◆ FprimeDeframer()

Svc::FprimeDeframer::FprimeDeframer ( const char *const  compName)

Construct FprimeDeframer object.

Parameters
compNameThe component name

Definition at line 20 of file FprimeDeframer.cpp.

◆ ~FprimeDeframer()

Svc::FprimeDeframer::~FprimeDeframer ( )

Destroy FprimeDeframer object.

Definition at line 22 of file FprimeDeframer.cpp.


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