![]() |
F´ Flight Software - C/C++ Documentation
devel
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for GroundInterface component. More...
#include <Svc/GroundInterface/GroundInterfaceComponentAc.hpp>
Protected Types | |
enum | { NUM_DOWNLINKPORT_INPUT_PORTS = 1 , NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS = 1 , NUM_READCALLBACK_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 } |
Enumerations for numbers of typed input ports. More... | |
enum | { NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 } |
Enumerations for numbers of special output ports. More... | |
enum | { NUM_FILEDOWNLINKBUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_FILEUPLINKBUFFERGET_OUTPUT_PORTS = 1 , NUM_FILEUPLINKBUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_READPOLL_OUTPUT_PORTS = 1 , NUM_UPLINKPORT_OUTPUT_PORTS = 1 , NUM_WRITE_OUTPUT_PORTS = 1 } |
Enumerations for numbers of typed output ports. More... | |
enum | { EVENTID_GROUNDINTERFACEERROR = 0x0 } |
Event IDs. More... | |
Friends | |
class | GroundInterfaceComponentBaseFriend |
Friend class for white-box testing. More... | |
Auto-generated base for GroundInterface component.
A component representing the FSW ground interface
Definition at line 32 of file GroundInterfaceComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_DOWNLINKPORT_INPUT_PORTS | |
NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS | |
NUM_READCALLBACK_INPUT_PORTS | |
NUM_SCHEDIN_INPUT_PORTS |
Definition at line 50 of file GroundInterfaceComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_LOG_OUTPUT_PORTS | |
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_TIME_OUTPUT_PORTS |
Definition at line 58 of file GroundInterfaceComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Definition at line 65 of file GroundInterfaceComponentAc.hpp.
|
protected |
Event IDs.
Enumerator | |
---|---|
EVENTID_GROUNDINTERFACEERROR | An error in the ground interface, here to make the UTs happy. |
Definition at line 75 of file GroundInterfaceComponentAc.hpp.
|
protected |
Construct GroundInterfaceComponentBase object.
compName | The component name |
Definition at line 723 of file GroundInterfaceComponentAc.cpp.
|
protectedvirtual |
Destroy GroundInterfaceComponentBase object.
Definition at line 730 of file GroundInterfaceComponentAc.cpp.
|
protectedpure virtual |
Handler for input port downlinkPort.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
|
protected |
Handler base-class function for input port downlinkPort.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 947 of file GroundInterfaceComponentAc.cpp.
|
protectedpure virtual |
Handler for input port fileDownlinkBufferSendIn.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port fileDownlinkBufferSendIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 974 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port fileDownlinkBufferSendOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1053 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port fileUplinkBufferGet.
portNum | The port number |
size | The requested size |
Definition at line 1068 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port fileUplinkBufferSendOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1083 of file GroundInterfaceComponentAc.cpp.
Fw::InputComPort * Svc::GroundInterfaceComponentBase::get_downlinkPort_InputPort | ( | NATIVE_INT_TYPE | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 405 of file GroundInterfaceComponentAc.cpp.
Fw::InputBufferSendPort * Svc::GroundInterfaceComponentBase::get_fileDownlinkBufferSendIn_InputPort | ( | NATIVE_INT_TYPE | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 416 of file GroundInterfaceComponentAc.cpp.
Fw::InputBufferSendPort * Svc::GroundInterfaceComponentBase::get_readCallback_InputPort | ( | NATIVE_INT_TYPE | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 427 of file GroundInterfaceComponentAc.cpp.
Svc::InputSchedPort * Svc::GroundInterfaceComponentBase::get_schedIn_InputPort | ( | NATIVE_INT_TYPE | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 438 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of downlinkPort input ports
Definition at line 740 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of fileDownlinkBufferSendIn input ports
Definition at line 746 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of fileDownlinkBufferSendOut output ports
Definition at line 794 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of fileUplinkBufferGet output ports
Definition at line 800 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of fileUplinkBufferSendOut output ports
Definition at line 806 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of Log output ports
Definition at line 768 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of readCallback input ports
Definition at line 752 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of readPoll output ports
Definition at line 812 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of schedIn input ports
Definition at line 758 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of Time output ports
Definition at line 784 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of uplinkPort output ports
Definition at line 818 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the number of write output ports
Definition at line 824 of file GroundInterfaceComponentAc.cpp.
|
protected |
Get the time
\return The current time
Definition at line 1224 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::init | ( | NATIVE_INT_TYPE | instance = 0 | ) |
Initialize GroundInterfaceComponentBase object.
instance | The instance number |
Definition at line 21 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port fileDownlinkBufferSendOut is connected
portNum | The port number |
Definition at line 875 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port fileUplinkBufferGet is connected
portNum | The port number |
Definition at line 886 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port fileUplinkBufferSendOut is connected
portNum | The port number |
Definition at line 897 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port Log is connected
portNum | The port number |
Definition at line 834 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port readPoll is connected
portNum | The port number |
Definition at line 908 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port Time is connected
portNum | The port number |
Definition at line 860 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port uplinkPort is connected
portNum | The port number |
Definition at line 919 of file GroundInterfaceComponentAc.cpp.
|
protected |
Check whether port write is connected
portNum | The port number |
Definition at line 930 of file GroundInterfaceComponentAc.cpp.
|
protectedvirtual |
Lock the guarded mutex.
Definition at line 1244 of file GroundInterfaceComponentAc.cpp.
|
protected |
Log event GroundInterfaceError
An error in the ground interface, here to make the UTs happy.
Definition at line 1149 of file GroundInterfaceComponentAc.cpp.
|
protectedpure virtual |
Handler for input port readCallback.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port readCallback.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 999 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port readPoll.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1098 of file GroundInterfaceComponentAc.cpp.
|
protectedpure virtual |
Handler for input port schedIn.
portNum | The port number |
context | The call order |
|
protected |
Handler base-class function for input port schedIn.
portNum | The port number |
context | The call order |
Definition at line 1024 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_fileDownlinkBufferSendOut_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to fileDownlinkBufferSendOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 503 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_fileUplinkBufferGet_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferGetPort * | port | ||
) |
Connect port to fileUplinkBufferGet[portNum].
portNum | The port number |
port | The input port |
Definition at line 517 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_fileUplinkBufferSendOut_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to fileUplinkBufferSendOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 531 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_Log_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to Log[portNum].
portNum | The port number |
port | The input port |
Definition at line 453 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_readPoll_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to readPoll[portNum].
portNum | The port number |
port | The input port |
Definition at line 545 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_Time_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to Time[portNum].
portNum | The port number |
port | The input port |
Definition at line 485 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_uplinkPort_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputComPort * | port | ||
) |
Connect port to uplinkPort[portNum].
portNum | The port number |
port | The input port |
Definition at line 559 of file GroundInterfaceComponentAc.cpp.
void Svc::GroundInterfaceComponentBase::set_write_OutputPort | ( | NATIVE_INT_TYPE | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to write[portNum].
portNum | The port number |
port | The input port |
Definition at line 573 of file GroundInterfaceComponentAc.cpp.
|
protectedvirtual |
Unlock the guarded mutex.
Definition at line 1250 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port uplinkPort.
portNum | The port number |
data | Buffer containing packet data |
context | Call context value; meaning chosen by user |
Definition at line 1113 of file GroundInterfaceComponentAc.cpp.
|
protected |
Invoke output port write.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 1130 of file GroundInterfaceComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 41 of file GroundInterfaceComponentAc.hpp.