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

#include <Svc/ComRetry/ComRetry.hpp>

Inheritance diagram for Svc::ComRetry:
Svc::ComRetryComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 ComRetry (const char *const compName)
 Construct ComRetry object. More...
 
 ~ComRetry ()
 Destroy ComRetry object. More...
 
void configure (U32 num_retries)
 Configure the number of retries. More...
 
- Public Member Functions inherited from Svc::ComRetryComponentBase
void init (FwEnumStoreType instance=0)
 Initialize ComRetryComponentBase object. More...
 
Fw::InputSuccessConditionPortget_comStatusIn_InputPort (FwIndexType portNum)
 
Svc::InputComDataWithContextPortget_dataIn_InputPort (FwIndexType portNum)
 
Svc::InputComDataWithContextPortget_dataReturnIn_InputPort (FwIndexType portNum)
 
void set_comStatusOut_OutputPort (FwIndexType portNum, Fw::InputSuccessConditionPort *port)
 Connect port to comStatusOut[portNum]. More...
 
void set_dataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataOut[portNum]. More...
 
void set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataReturnOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const FwIdType)
 Set the ID base. More...
 
FwIdType getIdBase () const
 

Additional Inherited Members

- Protected Types inherited from Svc::ComRetryComponentBase
enum  { NUM_COMSTATUSIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_DATARETURNIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_COMSTATUSOUT_OUTPUT_PORTS = 1, NUM_DATAOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
- Protected Member Functions inherited from Svc::ComRetryComponentBase
 ComRetryComponentBase (const char *compName="")
 Construct ComRetryComponentBase object. More...
 
virtual ~ComRetryComponentBase ()
 Destroy ComRetryComponentBase object. More...
 
bool isConnected_comStatusOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataReturnOut_OutputPort (FwIndexType portNum)
 
void comStatusIn_handlerBase (FwIndexType portNum, Fw::Success &condition)
 Handler base-class function for input port comStatusIn. More...
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataIn. More...
 
void dataReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataReturnIn. More...
 
void comStatusOut_out (FwIndexType portNum, Fw::Success &condition)
 Invoke output port comStatusOut. More...
 
void dataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port dataOut. More...
 
void dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Invoke output port dataReturnOut. 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...
 
- Static Protected Member Functions inherited from Svc::ComRetryComponentBase
static constexpr FwIndexType getNum_comStatusIn_InputPorts ()
 
static constexpr FwIndexType getNum_dataIn_InputPorts ()
 
static constexpr FwIndexType getNum_dataReturnIn_InputPorts ()
 
static constexpr FwIndexType getNum_comStatusOut_OutputPorts ()
 
static constexpr FwIndexType getNum_dataOut_OutputPorts ()
 
static constexpr FwIndexType getNum_dataReturnOut_OutputPorts ()
 

Detailed Description

Definition at line 14 of file ComRetry.hpp.

Constructor & Destructor Documentation

◆ ComRetry()

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

Construct ComRetry object.

Parameters
compNameThe component name

Definition at line 16 of file ComRetry.cpp.

◆ ~ComRetry()

Svc::ComRetry::~ComRetry ( )

Destroy ComRetry object.

Definition at line 23 of file ComRetry.cpp.

Member Function Documentation

◆ configure()

void Svc::ComRetry::configure ( U32  num_retries)

Configure the number of retries.

Parameters
num_retriesNumber of retries allowed

Definition at line 25 of file ComRetry.cpp.


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