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

Auto-generated base for FprimeRouter component. More...

#include <Svc/FprimeRouter/FprimeRouterComponentAc.hpp>

Inheritance diagram for Svc::FprimeRouterComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::FprimeRouter

Public Member Functions

void init (FwEnumStoreType instance=0)
 Initialize FprimeRouterComponentBase object. More...
 
Fw::InputCmdResponsePortget_cmdResponseIn_InputPort (FwIndexType portNum)
 
Svc::InputComDataWithContextPortget_dataIn_InputPort (FwIndexType portNum)
 
Fw::InputBufferSendPortget_fileBufferReturnIn_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_commandOut_OutputPort (FwIndexType portNum, Fw::InputComPort *port)
 Connect port to commandOut[portNum]. More...
 
void set_dataReturnOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to dataReturnOut[portNum]. More...
 
void set_fileOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to fileOut[portNum]. More...
 
void set_unknownDataOut_OutputPort (FwIndexType portNum, Svc::InputComDataWithContextPort *port)
 Connect port to unknownDataOut[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const FwIdType)
 Set the ID base. More...
 
FwIdType getIdBase () const
 
virtual void deinit ()
 Deinitialization function. More...
 

Protected Types

enum  { NUM_CMDRESPONSEIN_INPUT_PORTS = 1, NUM_DATAIN_INPUT_PORTS = 1, NUM_FILEBUFFERRETURNIN_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_COMMANDOUT_OUTPUT_PORTS = 1, NUM_DATARETURNOUT_OUTPUT_PORTS = 1, NUM_FILEOUT_OUTPUT_PORTS = 1, NUM_UNKNOWNDATAOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { EVENTID_SERIALIZATIONERROR = 0x0, EVENTID_DESERIALIZATIONERROR = 0x1 }
 Event IDs. More...
 

Protected Member Functions

 FprimeRouterComponentBase (const char *compName="")
 Construct FprimeRouterComponentBase object. More...
 
virtual ~FprimeRouterComponentBase ()
 Destroy FprimeRouterComponentBase object. More...
 
bool isConnected_logOut_OutputPort (FwIndexType portNum) const
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum) const
 
bool isConnected_commandOut_OutputPort (FwIndexType portNum) const
 
bool isConnected_dataReturnOut_OutputPort (FwIndexType portNum) const
 
bool isConnected_fileOut_OutputPort (FwIndexType portNum) const
 
bool isConnected_unknownDataOut_OutputPort (FwIndexType portNum) const
 
virtual void cmdResponseIn_handler (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)=0
 Handler for input port cmdResponseIn. More...
 
virtual void dataIn_handler (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)=0
 Handler for input port dataIn. More...
 
virtual void fileBufferReturnIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port fileBufferReturnIn. More...
 
void cmdResponseIn_handlerBase (FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdResponse &response)
 Handler base-class function for input port cmdResponseIn. More...
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context)
 Handler base-class function for input port dataIn. More...
 
void fileBufferReturnIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port fileBufferReturnIn. More...
 
void commandOut_out (FwIndexType portNum, Fw::ComBuffer &data, U32 context) const
 Invoke output port commandOut. More...
 
void dataReturnOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const
 Invoke output port dataReturnOut. More...
 
void fileOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) const
 Invoke output port fileOut. More...
 
void unknownDataOut_out (FwIndexType portNum, Fw::Buffer &data, const ComCfg::FrameContext &context) const
 Invoke output port unknownDataOut. More...
 
void log_WARNING_HI_SerializationError (U32 status) const
 
void log_WARNING_HI_DeserializationError (U32 status) const
 
Fw::Time getTime () const
 
- 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

static constexpr FwIndexType getNum_cmdResponseIn_InputPorts ()
 
static constexpr FwIndexType getNum_dataIn_InputPorts ()
 
static constexpr FwIndexType getNum_fileBufferReturnIn_InputPorts ()
 
static constexpr FwIndexType getNum_logOut_OutputPorts ()
 
static constexpr FwIndexType getNum_timeCaller_OutputPorts ()
 
static constexpr FwIndexType getNum_commandOut_OutputPorts ()
 
static constexpr FwIndexType getNum_dataReturnOut_OutputPorts ()
 
static constexpr FwIndexType getNum_fileOut_OutputPorts ()
 
static constexpr FwIndexType getNum_unknownDataOut_OutputPorts ()
 

Friends

class FprimeRouterTesterBase
 Friend class tester to support autocoded test harness. More...
 
class FprimeRouterTester
 Friend class tester implementation to support white-box testing. More...
 

Detailed Description

Auto-generated base for FprimeRouter component.

Routes packets deframed by the Deframer to the rest of the system

Definition at line 37 of file FprimeRouterComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_CMDRESPONSEIN_INPUT_PORTS 
NUM_DATAIN_INPUT_PORTS 
NUM_FILEBUFFERRETURNIN_INPUT_PORTS 

Definition at line 57 of file FprimeRouterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOGOUT_OUTPUT_PORTS 
NUM_LOGTEXTOUT_OUTPUT_PORTS 
NUM_TIMECALLER_OUTPUT_PORTS 

Definition at line 64 of file FprimeRouterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_COMMANDOUT_OUTPUT_PORTS 
NUM_DATARETURNOUT_OUTPUT_PORTS 
NUM_FILEOUT_OUTPUT_PORTS 
NUM_UNKNOWNDATAOUT_OUTPUT_PORTS 

Definition at line 71 of file FprimeRouterComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_SERIALIZATIONERROR 

An error occurred while serializing a com buffer.

EVENTID_DESERIALIZATIONERROR 

An error occurred while deserializing a packet.

Definition at line 79 of file FprimeRouterComponentAc.hpp.

Constructor & Destructor Documentation

◆ FprimeRouterComponentBase()

Svc::FprimeRouterComponentBase::FprimeRouterComponentBase ( const char *  compName = "")
protected

Construct FprimeRouterComponentBase object.

Parameters
compNameThe component name

Definition at line 534 of file FprimeRouterComponentAc.cpp.

◆ ~FprimeRouterComponentBase()

Svc::FprimeRouterComponentBase::~FprimeRouterComponentBase ( )
protectedvirtual

Destroy FprimeRouterComponentBase object.

Definition at line 541 of file FprimeRouterComponentAc.cpp.

Member Function Documentation

◆ cmdResponseIn_handler()

virtual void Svc::FprimeRouterComponentBase::cmdResponseIn_handler ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protectedpure virtual

Handler for input port cmdResponseIn.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

◆ cmdResponseIn_handlerBase()

void Svc::FprimeRouterComponentBase::cmdResponseIn_handlerBase ( FwIndexType  portNum,
FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdResponse response 
)
protected

Handler base-class function for input port cmdResponseIn.

Parameters
portNumThe port number
opCodeCommand Op Code
cmdSeqCommand Sequence
responseThe command response argument

Definition at line 650 of file FprimeRouterComponentAc.cpp.

◆ commandOut_out()

void Svc::FprimeRouterComponentBase::commandOut_out ( FwIndexType  portNum,
Fw::ComBuffer data,
U32  context 
) const
protected

Invoke output port commandOut.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 719 of file FprimeRouterComponentAc.cpp.

◆ dataIn_handler()

virtual void Svc::FprimeRouterComponentBase::dataIn_handler ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protectedpure virtual

Handler for input port dataIn.

Parameters
portNumThe port number

◆ dataIn_handlerBase()

void Svc::FprimeRouterComponentBase::dataIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
)
protected

Handler base-class function for input port dataIn.

Parameters
portNumThe port number

Definition at line 673 of file FprimeRouterComponentAc.cpp.

◆ dataReturnOut_out()

void Svc::FprimeRouterComponentBase::dataReturnOut_out ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
) const
protected

Invoke output port dataReturnOut.

Parameters
portNumThe port number

Definition at line 741 of file FprimeRouterComponentAc.cpp.

◆ fileBufferReturnIn_handler()

virtual void Svc::FprimeRouterComponentBase::fileBufferReturnIn_handler ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port fileBufferReturnIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ fileBufferReturnIn_handlerBase()

void Svc::FprimeRouterComponentBase::fileBufferReturnIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port fileBufferReturnIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 694 of file FprimeRouterComponentAc.cpp.

◆ fileOut_out()

void Svc::FprimeRouterComponentBase::fileOut_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
) const
protected

Invoke output port fileOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 763 of file FprimeRouterComponentAc.cpp.

◆ get_cmdResponseIn_InputPort()

Fw::InputCmdResponsePort * Svc::FprimeRouterComponentBase::get_cmdResponseIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
cmdResponseIn[portNum]
Parameters
portNumThe port number

Definition at line 259 of file FprimeRouterComponentAc.cpp.

◆ get_dataIn_InputPort()

Svc::InputComDataWithContextPort * Svc::FprimeRouterComponentBase::get_dataIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
dataIn[portNum]
Parameters
portNumThe port number

Definition at line 270 of file FprimeRouterComponentAc.cpp.

◆ get_fileBufferReturnIn_InputPort()

Fw::InputBufferSendPort * Svc::FprimeRouterComponentBase::get_fileBufferReturnIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
fileBufferReturnIn[portNum]
Parameters
portNumThe port number

Definition at line 281 of file FprimeRouterComponentAc.cpp.

◆ getNum_cmdResponseIn_InputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_cmdResponseIn_InputPorts ( )
inlinestaticprotected

Get the number of cmdResponseIn input ports

Returns
The number of cmdResponseIn input ports

Definition at line 281 of file FprimeRouterComponentAc.hpp.

◆ getNum_commandOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_commandOut_OutputPorts ( )
inlinestaticprotected

Get the number of commandOut output ports

Returns
The number of commandOut output ports

Definition at line 339 of file FprimeRouterComponentAc.hpp.

◆ getNum_dataIn_InputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_dataIn_InputPorts ( )
inlinestaticprotected

Get the number of dataIn input ports

Returns
The number of dataIn input ports

Definition at line 288 of file FprimeRouterComponentAc.hpp.

◆ getNum_dataReturnOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_dataReturnOut_OutputPorts ( )
inlinestaticprotected

Get the number of dataReturnOut output ports

Returns
The number of dataReturnOut output ports

Definition at line 346 of file FprimeRouterComponentAc.hpp.

◆ getNum_fileBufferReturnIn_InputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_fileBufferReturnIn_InputPorts ( )
inlinestaticprotected

Get the number of fileBufferReturnIn input ports

Returns
The number of fileBufferReturnIn input ports

Definition at line 295 of file FprimeRouterComponentAc.hpp.

◆ getNum_fileOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_fileOut_OutputPorts ( )
inlinestaticprotected

Get the number of fileOut output ports

Returns
The number of fileOut output ports

Definition at line 353 of file FprimeRouterComponentAc.hpp.

◆ getNum_logOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_logOut_OutputPorts ( )
inlinestaticprotected

Get the number of logOut output ports

Returns
The number of logOut output ports

Definition at line 308 of file FprimeRouterComponentAc.hpp.

◆ getNum_timeCaller_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_timeCaller_OutputPorts ( )
inlinestaticprotected

Get the number of timeCaller output ports

Returns
The number of timeCaller output ports

Definition at line 326 of file FprimeRouterComponentAc.hpp.

◆ getNum_unknownDataOut_OutputPorts()

static constexpr FwIndexType Svc::FprimeRouterComponentBase::getNum_unknownDataOut_OutputPorts ( )
inlinestaticprotected

Get the number of unknownDataOut output ports

Returns
The number of unknownDataOut output ports

Definition at line 360 of file FprimeRouterComponentAc.hpp.

◆ getTime()

Fw::Time Svc::FprimeRouterComponentBase::getTime ( ) const
protected

Get the time

\return The current time

Definition at line 979 of file FprimeRouterComponentAc.cpp.

◆ init()

void Svc::FprimeRouterComponentBase::init ( FwEnumStoreType  instance = 0)

Initialize FprimeRouterComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file FprimeRouterComponentAc.cpp.

◆ isConnected_commandOut_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_commandOut_OutputPort ( FwIndexType  portNum) const
protected

Check whether port commandOut is connected

Returns
Whether port commandOut is connected
Parameters
portNumThe port number

Definition at line 598 of file FprimeRouterComponentAc.cpp.

◆ isConnected_dataReturnOut_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_dataReturnOut_OutputPort ( FwIndexType  portNum) const
protected

Check whether port dataReturnOut is connected

Returns
Whether port dataReturnOut is connected
Parameters
portNumThe port number

Definition at line 609 of file FprimeRouterComponentAc.cpp.

◆ isConnected_fileOut_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_fileOut_OutputPort ( FwIndexType  portNum) const
protected

Check whether port fileOut is connected

Returns
Whether port fileOut is connected
Parameters
portNumThe port number

Definition at line 620 of file FprimeRouterComponentAc.cpp.

◆ isConnected_logOut_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_logOut_OutputPort ( FwIndexType  portNum) const
protected

Check whether port logOut is connected

Returns
Whether port logOut is connected
Parameters
portNumThe port number

Definition at line 553 of file FprimeRouterComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum) const
protected

Check whether port timeCaller is connected

Returns
Whether port timeCaller is connected
Parameters
portNumThe port number

Definition at line 579 of file FprimeRouterComponentAc.cpp.

◆ isConnected_unknownDataOut_OutputPort()

bool Svc::FprimeRouterComponentBase::isConnected_unknownDataOut_OutputPort ( FwIndexType  portNum) const
protected

Check whether port unknownDataOut is connected

Returns
Whether port unknownDataOut is connected
Parameters
portNumThe port number

Definition at line 631 of file FprimeRouterComponentAc.cpp.

◆ log_WARNING_HI_DeserializationError()

void Svc::FprimeRouterComponentBase::log_WARNING_HI_DeserializationError ( U32  status) const
protected

Log event DeserializationError

An error occurred while deserializing a packet

Parameters
statusThe status of the operation

Definition at line 893 of file FprimeRouterComponentAc.cpp.

◆ log_WARNING_HI_SerializationError()

void Svc::FprimeRouterComponentBase::log_WARNING_HI_SerializationError ( U32  status) const
protected

Log event SerializationError

An error occurred while serializing a com buffer

Parameters
statusThe status of the operation

Definition at line 811 of file FprimeRouterComponentAc.cpp.

◆ set_commandOut_OutputPort()

void Svc::FprimeRouterComponentBase::set_commandOut_OutputPort ( FwIndexType  portNum,
Fw::InputComPort port 
)

Connect port to commandOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 354 of file FprimeRouterComponentAc.cpp.

◆ set_dataReturnOut_OutputPort()

void Svc::FprimeRouterComponentBase::set_dataReturnOut_OutputPort ( FwIndexType  portNum,
Svc::InputComDataWithContextPort port 
)

Connect port to dataReturnOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 368 of file FprimeRouterComponentAc.cpp.

◆ set_fileOut_OutputPort()

void Svc::FprimeRouterComponentBase::set_fileOut_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to fileOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 382 of file FprimeRouterComponentAc.cpp.

◆ set_logOut_OutputPort()

void Svc::FprimeRouterComponentBase::set_logOut_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to logOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 300 of file FprimeRouterComponentAc.cpp.

◆ set_timeCaller_OutputPort()

void Svc::FprimeRouterComponentBase::set_timeCaller_OutputPort ( FwIndexType  portNum,
Fw::InputTimePort port 
)

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 332 of file FprimeRouterComponentAc.cpp.

◆ set_unknownDataOut_OutputPort()

void Svc::FprimeRouterComponentBase::set_unknownDataOut_OutputPort ( FwIndexType  portNum,
Svc::InputComDataWithContextPort port 
)

Connect port to unknownDataOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 396 of file FprimeRouterComponentAc.cpp.

◆ unknownDataOut_out()

void Svc::FprimeRouterComponentBase::unknownDataOut_out ( FwIndexType  portNum,
Fw::Buffer data,
const ComCfg::FrameContext context 
) const
protected

Invoke output port unknownDataOut.

Parameters
portNumThe port number

Definition at line 783 of file FprimeRouterComponentAc.cpp.

Friends And Related Function Documentation

◆ FprimeRouterTester

friend class FprimeRouterTester
friend

Friend class tester implementation to support white-box testing.

Definition at line 48 of file FprimeRouterComponentAc.hpp.

◆ FprimeRouterTesterBase

friend class FprimeRouterTesterBase
friend

Friend class tester to support autocoded test harness.

Definition at line 46 of file FprimeRouterComponentAc.hpp.


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