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

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

#include <Svc/GenericHub/GenericHubComponentAc.hpp>

Inheritance diagram for Svc::GenericHubComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::GenericHubComponentImpl

Public Member Functions

void init (NATIVE_INT_TYPE instance=0)
 Initialize GenericHubComponentBase object. More...
 
Fw::InputLogPortget_LogRecv_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputTlmPortget_TlmRecv_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputBufferSendPortget_buffersIn_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputBufferSendPortget_dataIn_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputSerializePort * get_portIn_InputPort (NATIVE_INT_TYPE portNum)
 
void set_LogSend_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
 Connect port to LogSend[portNum]. More...
 
void set_TlmSend_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTlmPort *port)
 Connect port to TlmSend[portNum]. More...
 
void set_bufferDeallocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferDeallocate[portNum]. More...
 
void set_buffersOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to buffersOut[portNum]. More...
 
void set_dataInDeallocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to dataInDeallocate[portNum]. More...
 
void set_dataOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to dataOut[portNum]. More...
 
void set_dataOutAllocate_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferGetPort *port)
 Connect port to dataOutAllocate[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_LOGRECV_INPUT_PORTS = 1 , NUM_TLMRECV_INPUT_PORTS = 1 , NUM_BUFFERSIN_INPUT_PORTS = 10 , NUM_DATAIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_PORTIN_INPUT_PORTS = 10 }
 Enumerations for numbers of serial input ports. More...
 
enum  {
  NUM_LOGSEND_OUTPUT_PORTS = 1 , NUM_TLMSEND_OUTPUT_PORTS = 1 , NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_BUFFERSOUT_OUTPUT_PORTS = 10 ,
  NUM_DATAINDEALLOCATE_OUTPUT_PORTS = 1 , NUM_DATAOUT_OUTPUT_PORTS = 1 , NUM_DATAOUTALLOCATE_OUTPUT_PORTS = 1
}
 Enumerations for numbers of typed output ports. More...
 
enum  { NUM_PORTOUT_OUTPUT_PORTS = 10 }
 Enumerations for numbers of serial output ports. More...
 

Protected Member Functions

 GenericHubComponentBase (const char *compName="")
 Construct GenericHubComponentBase object. More...
 
virtual ~GenericHubComponentBase ()
 Destroy GenericHubComponentBase object. More...
 
NATIVE_INT_TYPE getNum_LogRecv_InputPorts () const
 
NATIVE_INT_TYPE getNum_TlmRecv_InputPorts () const
 
NATIVE_INT_TYPE getNum_buffersIn_InputPorts () const
 
NATIVE_INT_TYPE getNum_dataIn_InputPorts () const
 
NATIVE_INT_TYPE getNum_portIn_InputPorts () const
 
NATIVE_INT_TYPE getNum_LogSend_OutputPorts () const
 
NATIVE_INT_TYPE getNum_TlmSend_OutputPorts () const
 
NATIVE_INT_TYPE getNum_bufferDeallocate_OutputPorts () const
 
NATIVE_INT_TYPE getNum_buffersOut_OutputPorts () const
 
NATIVE_INT_TYPE getNum_dataInDeallocate_OutputPorts () const
 
NATIVE_INT_TYPE getNum_dataOut_OutputPorts () const
 
NATIVE_INT_TYPE getNum_dataOutAllocate_OutputPorts () const
 
NATIVE_INT_TYPE getNum_portOut_OutputPorts () const
 
bool isConnected_LogSend_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_TlmSend_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_bufferDeallocate_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_buffersOut_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_dataInDeallocate_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_dataOut_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_dataOutAllocate_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_portOut_OutputPort (NATIVE_INT_TYPE portNum)
 
virtual void LogRecv_handler (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)=0
 Handler for input port LogRecv. More...
 
virtual void TlmRecv_handler (NATIVE_INT_TYPE portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0
 Handler for input port TlmRecv. More...
 
virtual void buffersIn_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port buffersIn. More...
 
virtual void dataIn_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port dataIn. More...
 
void LogRecv_handlerBase (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
 Handler base-class function for input port LogRecv. More...
 
void TlmRecv_handlerBase (NATIVE_INT_TYPE portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 Handler base-class function for input port TlmRecv. More...
 
void buffersIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port buffersIn. More...
 
void dataIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port dataIn. More...
 
virtual void portIn_handler (NATIVE_INT_TYPE portNum, Fw::SerializeBufferBase &buffer)=0
 Handler for input port portIn. More...
 
void portIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::SerializeBufferBase &buffer)
 Handler base-class function for input port portIn. More...
 
void LogSend_out (NATIVE_INT_TYPE portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
 Invoke output port LogSend. More...
 
void TlmSend_out (NATIVE_INT_TYPE portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 Invoke output port TlmSend. More...
 
void bufferDeallocate_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferDeallocate. More...
 
void buffersOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port buffersOut. More...
 
void dataInDeallocate_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port dataInDeallocate. More...
 
void dataOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port dataOut. More...
 
Fw::Buffer dataOutAllocate_out (NATIVE_INT_TYPE portNum, U32 size)
 Invoke output port dataOutAllocate. More...
 
Fw::SerializeStatus portOut_out (NATIVE_INT_TYPE portNum, Fw::SerializeBufferBase &buffer)
 Invoke output port portOut. More...
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor. More...
 
virtual ~PassiveComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 Initialization function. More...
 
NATIVE_INT_TYPE 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...
 

Friends

class GenericHubComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for GenericHub component.

A generic hub component

Definition at line 30 of file GenericHubComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_LOGRECV_INPUT_PORTS 
NUM_TLMRECV_INPUT_PORTS 
NUM_BUFFERSIN_INPUT_PORTS 
NUM_DATAIN_INPUT_PORTS 

Definition at line 48 of file GenericHubComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of serial input ports.

Enumerator
NUM_PORTIN_INPUT_PORTS 

Definition at line 56 of file GenericHubComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_LOGSEND_OUTPUT_PORTS 
NUM_TLMSEND_OUTPUT_PORTS 
NUM_BUFFERDEALLOCATE_OUTPUT_PORTS 
NUM_BUFFERSOUT_OUTPUT_PORTS 
NUM_DATAINDEALLOCATE_OUTPUT_PORTS 
NUM_DATAOUT_OUTPUT_PORTS 
NUM_DATAOUTALLOCATE_OUTPUT_PORTS 

Definition at line 61 of file GenericHubComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of serial output ports.

Enumerator
NUM_PORTOUT_OUTPUT_PORTS 

Definition at line 72 of file GenericHubComponentAc.hpp.

Constructor & Destructor Documentation

◆ GenericHubComponentBase()

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

Construct GenericHubComponentBase object.

Parameters
compNameThe component name

Definition at line 687 of file GenericHubComponentAc.cpp.

◆ ~GenericHubComponentBase()

Svc::GenericHubComponentBase::~GenericHubComponentBase ( )
protectedvirtual

Destroy GenericHubComponentBase object.

Definition at line 694 of file GenericHubComponentAc.cpp.

Member Function Documentation

◆ bufferDeallocate_out()

void Svc::GenericHubComponentBase::bufferDeallocate_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port bufferDeallocate.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1051 of file GenericHubComponentAc.cpp.

◆ buffersIn_handler()

virtual void Svc::GenericHubComponentBase::buffersIn_handler ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port buffersIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ buffersIn_handlerBase()

void Svc::GenericHubComponentBase::buffersIn_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port buffersIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 944 of file GenericHubComponentAc.cpp.

◆ buffersOut_out()

void Svc::GenericHubComponentBase::buffersOut_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port buffersOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1066 of file GenericHubComponentAc.cpp.

◆ dataIn_handler()

virtual void Svc::GenericHubComponentBase::dataIn_handler ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port dataIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ dataIn_handlerBase()

void Svc::GenericHubComponentBase::dataIn_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port dataIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 963 of file GenericHubComponentAc.cpp.

◆ dataInDeallocate_out()

void Svc::GenericHubComponentBase::dataInDeallocate_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port dataInDeallocate.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1081 of file GenericHubComponentAc.cpp.

◆ dataOut_out()

void Svc::GenericHubComponentBase::dataOut_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port dataOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1096 of file GenericHubComponentAc.cpp.

◆ dataOutAllocate_out()

Fw::Buffer Svc::GenericHubComponentBase::dataOutAllocate_out ( NATIVE_INT_TYPE  portNum,
U32  size 
)
protected

Invoke output port dataOutAllocate.

Parameters
portNumThe port number
sizeThe requested size

Definition at line 1111 of file GenericHubComponentAc.cpp.

◆ get_buffersIn_InputPort()

Fw::InputBufferSendPort * Svc::GenericHubComponentBase::get_buffersIn_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
buffersIn[portNum]
Parameters
portNumThe port number

Definition at line 430 of file GenericHubComponentAc.cpp.

◆ get_dataIn_InputPort()

Fw::InputBufferSendPort * Svc::GenericHubComponentBase::get_dataIn_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
dataIn[portNum]
Parameters
portNumThe port number

Definition at line 441 of file GenericHubComponentAc.cpp.

◆ get_LogRecv_InputPort()

Fw::InputLogPort * Svc::GenericHubComponentBase::get_LogRecv_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
LogRecv[portNum]
Parameters
portNumThe port number

Definition at line 408 of file GenericHubComponentAc.cpp.

◆ get_portIn_InputPort()

Fw::InputSerializePort * Svc::GenericHubComponentBase::get_portIn_InputPort ( NATIVE_INT_TYPE  portNum)

Get serial input port at index

Returns
portIn[portNum]
Parameters
portNumThe port number

Definition at line 456 of file GenericHubComponentAc.cpp.

◆ get_TlmRecv_InputPort()

Fw::InputTlmPort * Svc::GenericHubComponentBase::get_TlmRecv_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
TlmRecv[portNum]
Parameters
portNumThe port number

Definition at line 419 of file GenericHubComponentAc.cpp.

◆ getNum_bufferDeallocate_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_bufferDeallocate_OutputPorts ( ) const
protected

Get the number of bufferDeallocate output ports

Returns
The number of bufferDeallocate output ports

Definition at line 754 of file GenericHubComponentAc.cpp.

◆ getNum_buffersIn_InputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_buffersIn_InputPorts ( ) const
protected

Get the number of buffersIn input ports

Returns
The number of buffersIn input ports

Definition at line 716 of file GenericHubComponentAc.cpp.

◆ getNum_buffersOut_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_buffersOut_OutputPorts ( ) const
protected

Get the number of buffersOut output ports

Returns
The number of buffersOut output ports

Definition at line 760 of file GenericHubComponentAc.cpp.

◆ getNum_dataIn_InputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_dataIn_InputPorts ( ) const
protected

Get the number of dataIn input ports

Returns
The number of dataIn input ports

Definition at line 722 of file GenericHubComponentAc.cpp.

◆ getNum_dataInDeallocate_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_dataInDeallocate_OutputPorts ( ) const
protected

Get the number of dataInDeallocate output ports

Returns
The number of dataInDeallocate output ports

Definition at line 766 of file GenericHubComponentAc.cpp.

◆ getNum_dataOut_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_dataOut_OutputPorts ( ) const
protected

Get the number of dataOut output ports

Returns
The number of dataOut output ports

Definition at line 772 of file GenericHubComponentAc.cpp.

◆ getNum_dataOutAllocate_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_dataOutAllocate_OutputPorts ( ) const
protected

Get the number of dataOutAllocate output ports

Returns
The number of dataOutAllocate output ports

Definition at line 778 of file GenericHubComponentAc.cpp.

◆ getNum_LogRecv_InputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_LogRecv_InputPorts ( ) const
protected

Get the number of LogRecv input ports

Returns
The number of LogRecv input ports

Definition at line 704 of file GenericHubComponentAc.cpp.

◆ getNum_LogSend_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_LogSend_OutputPorts ( ) const
protected

Get the number of LogSend output ports

Returns
The number of LogSend output ports

Definition at line 742 of file GenericHubComponentAc.cpp.

◆ getNum_portIn_InputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_portIn_InputPorts ( ) const
protected

Get the number of portIn input ports

Returns
The number of portIn input ports

Definition at line 732 of file GenericHubComponentAc.cpp.

◆ getNum_portOut_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_portOut_OutputPorts ( ) const
protected

Get the number of portOut output ports

Returns
The number of portOut output ports

Definition at line 788 of file GenericHubComponentAc.cpp.

◆ getNum_TlmRecv_InputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_TlmRecv_InputPorts ( ) const
protected

Get the number of TlmRecv input ports

Returns
The number of TlmRecv input ports

Definition at line 710 of file GenericHubComponentAc.cpp.

◆ getNum_TlmSend_OutputPorts()

NATIVE_INT_TYPE Svc::GenericHubComponentBase::getNum_TlmSend_OutputPorts ( ) const
protected

Get the number of TlmSend output ports

Returns
The number of TlmSend output ports

Definition at line 748 of file GenericHubComponentAc.cpp.

◆ init()

void Svc::GenericHubComponentBase::init ( NATIVE_INT_TYPE  instance = 0)

Initialize GenericHubComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file GenericHubComponentAc.cpp.

◆ isConnected_bufferDeallocate_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_bufferDeallocate_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port bufferDeallocate is connected

Returns
Whether port bufferDeallocate is connected
Parameters
portNumThe port number

Definition at line 820 of file GenericHubComponentAc.cpp.

◆ isConnected_buffersOut_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_buffersOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port buffersOut is connected

Returns
Whether port buffersOut is connected
Parameters
portNumThe port number

Definition at line 831 of file GenericHubComponentAc.cpp.

◆ isConnected_dataInDeallocate_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_dataInDeallocate_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port dataInDeallocate is connected

Returns
Whether port dataInDeallocate is connected
Parameters
portNumThe port number

Definition at line 842 of file GenericHubComponentAc.cpp.

◆ isConnected_dataOut_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_dataOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port dataOut is connected

Returns
Whether port dataOut is connected
Parameters
portNumThe port number

Definition at line 853 of file GenericHubComponentAc.cpp.

◆ isConnected_dataOutAllocate_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_dataOutAllocate_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port dataOutAllocate is connected

Returns
Whether port dataOutAllocate is connected
Parameters
portNumThe port number

Definition at line 864 of file GenericHubComponentAc.cpp.

◆ isConnected_LogSend_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_LogSend_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port LogSend is connected

Returns
Whether port LogSend is connected
Parameters
portNumThe port number

Definition at line 798 of file GenericHubComponentAc.cpp.

◆ isConnected_portOut_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_portOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port portOut is connected

Returns
Whether port portOut is connected
Parameters
portNumThe port number

Definition at line 879 of file GenericHubComponentAc.cpp.

◆ isConnected_TlmSend_OutputPort()

bool Svc::GenericHubComponentBase::isConnected_TlmSend_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port TlmSend is connected

Returns
Whether port TlmSend is connected
Parameters
portNumThe port number

Definition at line 809 of file GenericHubComponentAc.cpp.

◆ LogRecv_handler()

virtual void Svc::GenericHubComponentBase::LogRecv_handler ( NATIVE_INT_TYPE  portNum,
FwEventIdType  id,
Fw::Time timeTag,
const Fw::LogSeverity severity,
Fw::LogBuffer args 
)
protectedpure virtual

Handler for input port LogRecv.

Parameters
portNumThe port number
idLog ID
timeTagTime Tag
severityThe severity argument
argsBuffer containing serialized log entry

◆ LogRecv_handlerBase()

void Svc::GenericHubComponentBase::LogRecv_handlerBase ( NATIVE_INT_TYPE  portNum,
FwEventIdType  id,
Fw::Time timeTag,
const Fw::LogSeverity severity,
Fw::LogBuffer args 
)
protected

Handler base-class function for input port LogRecv.

Parameters
portNumThe port number
idLog ID
timeTagTime Tag
severityThe severity argument
argsBuffer containing serialized log entry

Definition at line 896 of file GenericHubComponentAc.cpp.

◆ LogSend_out()

void Svc::GenericHubComponentBase::LogSend_out ( NATIVE_INT_TYPE  portNum,
FwEventIdType  id,
Fw::Time timeTag,
const Fw::LogSeverity severity,
Fw::LogBuffer args 
)
protected

Invoke output port LogSend.

Parameters
portNumThe port number
idLog ID
timeTagTime Tag
severityThe severity argument
argsBuffer containing serialized log entry

Definition at line 1011 of file GenericHubComponentAc.cpp.

◆ portIn_handler()

virtual void Svc::GenericHubComponentBase::portIn_handler ( NATIVE_INT_TYPE  portNum,
Fw::SerializeBufferBase buffer 
)
protectedpure virtual

Handler for input port portIn.

Parameters
portNumThe port number
bufferThe serialization buffer

◆ portIn_handlerBase()

void Svc::GenericHubComponentBase::portIn_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::SerializeBufferBase buffer 
)
protected

Handler base-class function for input port portIn.

Parameters
portNumThe port number
bufferThe serialization buffer

Definition at line 988 of file GenericHubComponentAc.cpp.

◆ portOut_out()

Fw::SerializeStatus Svc::GenericHubComponentBase::portOut_out ( NATIVE_INT_TYPE  portNum,
Fw::SerializeBufferBase buffer 
)
protected

Invoke output port portOut.

Parameters
portNumThe port number
bufferThe serialization buffer

Definition at line 1130 of file GenericHubComponentAc.cpp.

◆ set_bufferDeallocate_OutputPort()

void Svc::GenericHubComponentBase::set_bufferDeallocate_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to bufferDeallocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 499 of file GenericHubComponentAc.cpp.

◆ set_buffersOut_OutputPort()

void Svc::GenericHubComponentBase::set_buffersOut_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to buffersOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 513 of file GenericHubComponentAc.cpp.

◆ set_dataInDeallocate_OutputPort()

void Svc::GenericHubComponentBase::set_dataInDeallocate_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to dataInDeallocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 527 of file GenericHubComponentAc.cpp.

◆ set_dataOut_OutputPort()

void Svc::GenericHubComponentBase::set_dataOut_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to dataOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 541 of file GenericHubComponentAc.cpp.

◆ set_dataOutAllocate_OutputPort()

void Svc::GenericHubComponentBase::set_dataOutAllocate_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferGetPort port 
)

Connect port to dataOutAllocate[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 555 of file GenericHubComponentAc.cpp.

◆ set_LogSend_OutputPort()

void Svc::GenericHubComponentBase::set_LogSend_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputLogPort port 
)

Connect port to LogSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 471 of file GenericHubComponentAc.cpp.

◆ set_TlmSend_OutputPort()

void Svc::GenericHubComponentBase::set_TlmSend_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputTlmPort port 
)

Connect port to TlmSend[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 485 of file GenericHubComponentAc.cpp.

◆ TlmRecv_handler()

virtual void Svc::GenericHubComponentBase::TlmRecv_handler ( NATIVE_INT_TYPE  portNum,
FwChanIdType  id,
Fw::Time timeTag,
Fw::TlmBuffer val 
)
protectedpure virtual

Handler for input port TlmRecv.

Parameters
portNumThe port number
idTelemetry Channel ID
timeTagTime Tag
valBuffer containing serialized telemetry value

◆ TlmRecv_handlerBase()

void Svc::GenericHubComponentBase::TlmRecv_handlerBase ( NATIVE_INT_TYPE  portNum,
FwChanIdType  id,
Fw::Time timeTag,
Fw::TlmBuffer val 
)
protected

Handler base-class function for input port TlmRecv.

Parameters
portNumThe port number
idTelemetry Channel ID
timeTagTime Tag
valBuffer containing serialized telemetry value

Definition at line 921 of file GenericHubComponentAc.cpp.

◆ TlmSend_out()

void Svc::GenericHubComponentBase::TlmSend_out ( NATIVE_INT_TYPE  portNum,
FwChanIdType  id,
Fw::Time timeTag,
Fw::TlmBuffer val 
)
protected

Invoke output port TlmSend.

Parameters
portNumThe port number
idTelemetry Channel ID
timeTagTime Tag
valBuffer containing serialized telemetry value

Definition at line 1032 of file GenericHubComponentAc.cpp.

Friends And Related Function Documentation

◆ GenericHubComponentBaseFriend

friend class GenericHubComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 39 of file GenericHubComponentAc.hpp.


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