![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for GenericHub component. More...
#include <Svc/GenericHub/GenericHubComponentAc.hpp>
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. | |
virtual | ~GenericHubComponentBase () |
Destroy GenericHubComponentBase object. | |
FwIndexType | getNum_LogRecv_InputPorts () const |
FwIndexType | getNum_TlmRecv_InputPorts () const |
FwIndexType | getNum_buffersIn_InputPorts () const |
FwIndexType | getNum_dataIn_InputPorts () const |
FwIndexType | getNum_portIn_InputPorts () const |
FwIndexType | getNum_LogSend_OutputPorts () const |
FwIndexType | getNum_TlmSend_OutputPorts () const |
FwIndexType | getNum_bufferDeallocate_OutputPorts () const |
FwIndexType | getNum_buffersOut_OutputPorts () const |
FwIndexType | getNum_dataInDeallocate_OutputPorts () const |
FwIndexType | getNum_dataOut_OutputPorts () const |
FwIndexType | getNum_dataOutAllocate_OutputPorts () const |
FwIndexType | getNum_portOut_OutputPorts () const |
bool | isConnected_LogSend_OutputPort (FwIndexType portNum) |
bool | isConnected_TlmSend_OutputPort (FwIndexType portNum) |
bool | isConnected_bufferDeallocate_OutputPort (FwIndexType portNum) |
bool | isConnected_buffersOut_OutputPort (FwIndexType portNum) |
bool | isConnected_dataInDeallocate_OutputPort (FwIndexType portNum) |
bool | isConnected_dataOut_OutputPort (FwIndexType portNum) |
bool | isConnected_dataOutAllocate_OutputPort (FwIndexType portNum) |
bool | isConnected_portOut_OutputPort (FwIndexType portNum) |
virtual void | LogRecv_handler (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)=0 |
Handler for input port LogRecv. | |
virtual void | TlmRecv_handler (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)=0 |
Handler for input port TlmRecv. | |
virtual void | buffersIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
Handler for input port buffersIn. | |
virtual void | dataIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
Handler for input port dataIn. | |
void | LogRecv_handlerBase (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args) |
Handler base-class function for input port LogRecv. | |
void | TlmRecv_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val) |
Handler base-class function for input port TlmRecv. | |
void | buffersIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port buffersIn. | |
void | dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port dataIn. | |
virtual void | portIn_handler (FwIndexType portNum, Fw::SerializeBufferBase &buffer)=0 |
Handler for input port portIn. | |
void | portIn_handlerBase (FwIndexType portNum, Fw::SerializeBufferBase &buffer) |
Handler base-class function for input port portIn. | |
void | LogSend_out (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args) |
Invoke output port LogSend. | |
void | TlmSend_out (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val) |
Invoke output port TlmSend. | |
void | bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port bufferDeallocate. | |
void | buffersOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port buffersOut. | |
void | dataInDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port dataInDeallocate. | |
void | dataOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port dataOut. | |
Fw::Buffer | dataOutAllocate_out (FwIndexType portNum, U32 size) |
Invoke output port dataOutAllocate. | |
Fw::SerializeStatus | portOut_out (FwIndexType portNum, Fw::SerializeBufferBase &buffer) |
Invoke output port portOut. | |
![]() | |
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. | |
Friends | |
class | GenericHubComponentBaseFriend |
Friend class for white-box testing. | |
Auto-generated base for GenericHub component.
A generic hub component
Definition at line 30 of file GenericHubComponentAc.hpp.
|
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.
|
protected |
Enumerations for numbers of serial input ports.
Enumerator | |
---|---|
NUM_PORTIN_INPUT_PORTS |
Definition at line 56 of file GenericHubComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Definition at line 61 of file GenericHubComponentAc.hpp.
|
protected |
Enumerations for numbers of serial output ports.
Enumerator | |
---|---|
NUM_PORTOUT_OUTPUT_PORTS |
Definition at line 72 of file GenericHubComponentAc.hpp.
|
protected |
Construct GenericHubComponentBase object.
compName | The component name |
Definition at line 582 of file GenericHubComponentAc.cpp.
|
protectedvirtual |
Destroy GenericHubComponentBase object.
Definition at line 589 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port bufferDeallocate.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 946 of file GenericHubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port buffersIn.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port buffersIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 839 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port buffersOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 961 of file GenericHubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port dataIn.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port dataIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 858 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port dataInDeallocate.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 976 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port dataOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 991 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port dataOutAllocate.
portNum | The port number |
size | The requested size |
Definition at line 1006 of file GenericHubComponentAc.cpp.
Fw::InputBufferSendPort * Svc::GenericHubComponentBase::get_buffersIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 325 of file GenericHubComponentAc.cpp.
Fw::InputBufferSendPort * Svc::GenericHubComponentBase::get_dataIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 336 of file GenericHubComponentAc.cpp.
Fw::InputLogPort * Svc::GenericHubComponentBase::get_LogRecv_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 303 of file GenericHubComponentAc.cpp.
Fw::InputSerializePort * Svc::GenericHubComponentBase::get_portIn_InputPort | ( | FwIndexType | portNum | ) |
Get serial input port at index
portNum | The port number |
Definition at line 351 of file GenericHubComponentAc.cpp.
Fw::InputTlmPort * Svc::GenericHubComponentBase::get_TlmRecv_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 314 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of bufferDeallocate output ports
Definition at line 649 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of buffersIn input ports
Definition at line 611 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of buffersOut output ports
Definition at line 655 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of dataIn input ports
Definition at line 617 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of dataInDeallocate output ports
Definition at line 661 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of dataOut output ports
Definition at line 667 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of dataOutAllocate output ports
Definition at line 673 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of LogRecv input ports
Definition at line 599 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of LogSend output ports
Definition at line 637 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of portIn input ports
Definition at line 627 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of portOut output ports
Definition at line 683 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of TlmRecv input ports
Definition at line 605 of file GenericHubComponentAc.cpp.
|
protected |
Get the number of TlmSend output ports
Definition at line 643 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::init | ( | FwEnumStoreType | instance = 0 | ) |
Initialize GenericHubComponentBase object.
instance | The instance number |
Definition at line 20 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port bufferDeallocate is connected
portNum | The port number |
Definition at line 715 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port buffersOut is connected
portNum | The port number |
Definition at line 726 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port dataInDeallocate is connected
portNum | The port number |
Definition at line 737 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port dataOut is connected
portNum | The port number |
Definition at line 748 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port dataOutAllocate is connected
portNum | The port number |
Definition at line 759 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port LogSend is connected
portNum | The port number |
Definition at line 693 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port portOut is connected
portNum | The port number |
Definition at line 774 of file GenericHubComponentAc.cpp.
|
protected |
Check whether port TlmSend is connected
portNum | The port number |
Definition at line 704 of file GenericHubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port LogRecv.
portNum | The port number |
id | Log ID |
timeTag | Time Tag |
severity | The severity argument |
args | Buffer containing serialized log entry |
|
protected |
Handler base-class function for input port LogRecv.
portNum | The port number |
id | Log ID |
timeTag | Time Tag |
severity | The severity argument |
args | Buffer containing serialized log entry |
Definition at line 791 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port LogSend.
portNum | The port number |
id | Log ID |
timeTag | Time Tag |
severity | The severity argument |
args | Buffer containing serialized log entry |
Definition at line 906 of file GenericHubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port portIn.
portNum | The port number |
buffer | The serialization buffer |
|
protected |
Handler base-class function for input port portIn.
portNum | The port number |
buffer | The serialization buffer |
Definition at line 883 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port portOut.
portNum | The port number |
buffer | The serialization buffer |
Definition at line 1025 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_bufferDeallocate_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to bufferDeallocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 394 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_buffersOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to buffersOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 408 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_dataInDeallocate_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to dataInDeallocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 422 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_dataOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to dataOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 436 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_dataOutAllocate_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferGetPort * | port | ||
) |
Connect port to dataOutAllocate[portNum].
portNum | The port number |
port | The input port |
Definition at line 450 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_LogSend_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to LogSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 366 of file GenericHubComponentAc.cpp.
void Svc::GenericHubComponentBase::set_TlmSend_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to TlmSend[portNum].
portNum | The port number |
port | The input port |
Definition at line 380 of file GenericHubComponentAc.cpp.
|
protectedpure virtual |
Handler for input port TlmRecv.
portNum | The port number |
id | Telemetry Channel ID |
timeTag | Time Tag |
val | Buffer containing serialized telemetry value |
|
protected |
Handler base-class function for input port TlmRecv.
portNum | The port number |
id | Telemetry Channel ID |
timeTag | Time Tag |
val | Buffer containing serialized telemetry value |
Definition at line 816 of file GenericHubComponentAc.cpp.
|
protected |
Invoke output port TlmSend.
portNum | The port number |
id | Telemetry Channel ID |
timeTag | Time Tag |
val | Buffer containing serialized telemetry value |
Definition at line 927 of file GenericHubComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 39 of file GenericHubComponentAc.hpp.