![]() |
F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
|
Auto-generated base for FileUplink component. More...
#include <Svc/FileUplink/FileUplinkComponentAc.hpp>
Public Member Functions | |
void | init (FwSizeType queueDepth, FwEnumStoreType instance=0) |
Initialize FileUplinkComponentBase object. More... | |
Fw::InputBufferSendPort * | get_bufferSendIn_InputPort (FwIndexType portNum) |
Svc::InputPingPort * | get_pingIn_InputPort (FwIndexType portNum) |
void | set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port) |
Connect port to eventOut[portNum]. More... | |
void | set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port) |
Connect port to timeCaller[portNum]. More... | |
void | set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port) |
Connect port to tlmOut[portNum]. More... | |
void | set_bufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port) |
Connect port to bufferSendOut[portNum]. More... | |
void | set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port) |
Connect port to pingOut[portNum]. More... | |
![]() | |
void | start (Os::Task::ParamType priority=Os::Task::TASK_DEFAULT, Os::Task::ParamType stackSize=Os::Task::TASK_DEFAULT, Os::Task::ParamType cpuAffinity=Os::Task::TASK_DEFAULT, Os::Task::ParamType identifier=Os::Task::TASK_DEFAULT) |
called by instantiator when task is to be started More... | |
void | exit () |
exit task in active component More... | |
Os::Task::Status | join () |
Join the thread. More... | |
DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()") | |
Join to thread with discarded value_ptr. More... | |
![]() | |
void | setIdBase (const U32) |
Set the ID base. More... | |
U32 | getIdBase () const |
Protected Member Functions | |
FileUplinkComponentBase (const char *compName="") | |
Construct FileUplinkComponentBase object. More... | |
virtual | ~FileUplinkComponentBase () |
Destroy FileUplinkComponentBase object. More... | |
FwIndexType | getNum_bufferSendIn_InputPorts () const |
FwIndexType | getNum_pingIn_InputPorts () const |
FwIndexType | getNum_eventOut_OutputPorts () const |
FwIndexType | getNum_timeCaller_OutputPorts () const |
FwIndexType | getNum_tlmOut_OutputPorts () const |
FwIndexType | getNum_bufferSendOut_OutputPorts () const |
FwIndexType | getNum_pingOut_OutputPorts () const |
bool | isConnected_eventOut_OutputPort (FwIndexType portNum) |
bool | isConnected_timeCaller_OutputPort (FwIndexType portNum) |
bool | isConnected_tlmOut_OutputPort (FwIndexType portNum) |
bool | isConnected_bufferSendOut_OutputPort (FwIndexType portNum) |
bool | isConnected_pingOut_OutputPort (FwIndexType portNum) |
virtual void | bufferSendIn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0 |
Handler for input port bufferSendIn. More... | |
virtual void | pingIn_handler (FwIndexType portNum, U32 key)=0 |
Handler for input port pingIn. More... | |
void | bufferSendIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Handler base-class function for input port bufferSendIn. More... | |
void | pingIn_handlerBase (FwIndexType portNum, U32 key) |
Handler base-class function for input port pingIn. More... | |
virtual void | bufferSendIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Pre-message hook for async input port bufferSendIn. More... | |
virtual void | pingIn_preMsgHook (FwIndexType portNum, U32 key) |
Pre-message hook for async input port pingIn. More... | |
void | bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer) |
Invoke output port bufferSendOut. More... | |
void | pingOut_out (FwIndexType portNum, U32 key) |
Invoke output port pingOut. More... | |
void | log_WARNING_HI_BadChecksum (const Fw::StringBase &fileName, U32 computed, U32 read) const |
void | log_WARNING_HI_FileOpenError (const Fw::StringBase &fileName) const |
void | log_ACTIVITY_HI_FileReceived (const Fw::StringBase &fileName) const |
void | log_WARNING_HI_FileWriteError (const Fw::StringBase &fileName) |
void | log_WARNING_HI_InvalidReceiveMode (U32 packetType, U32 mode) |
void | log_WARNING_HI_PacketOutOfBounds (U32 packetIndex, const Fw::StringBase &fileName) |
void | log_WARNING_HI_PacketOutOfOrder (U32 packetIndex, U32 lastPacketIndex) |
void | log_WARNING_HI_PacketDuplicate (U32 packetIndex) |
void | log_ACTIVITY_HI_UplinkCanceled () const |
void | log_WARNING_HI_DecodeError (I32 status) const |
void | log_WARNING_HI_FileWriteError_ThrottleClear () |
Reset throttle value for FileWriteError. More... | |
void | log_WARNING_HI_InvalidReceiveMode_ThrottleClear () |
Reset throttle value for InvalidReceiveMode. More... | |
void | log_WARNING_HI_PacketOutOfBounds_ThrottleClear () |
Reset throttle value for PacketOutOfBounds. More... | |
void | log_WARNING_HI_PacketOutOfOrder_ThrottleClear () |
Reset throttle value for PacketOutOfOrder. More... | |
void | log_WARNING_HI_PacketDuplicate_ThrottleClear () |
Reset throttle value for PacketDuplicate. More... | |
void | tlmWrite_FilesReceived (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
void | tlmWrite_PacketsReceived (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
void | tlmWrite_Warnings (U32 arg, Fw::Time _tlmTime=Fw::Time()) const |
Fw::Time | getTime () |
![]() | |
ActiveComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~ActiveComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization code More... | |
virtual void | preamble () |
A function that will be called before the event loop is entered. More... | |
MsgDispatchStatus | dispatch () |
The function that will dispatching messages. More... | |
virtual void | finalizer () |
A function that will be called after exiting the loop. More... | |
![]() | |
QueuedComponentBase (const char *name) | |
Constructor. More... | |
virtual | ~QueuedComponentBase () |
Destructor. More... | |
void | init (NATIVE_INT_TYPE instance) |
initialization function More... | |
Os::Queue::Status | createQueue (FwSizeType depth, FwSizeType msgSize) |
NATIVE_INT_TYPE | getNumMsgsDropped () |
return number of messages dropped More... | |
void | incNumMsgDropped () |
increment the number of messages dropped More... | |
![]() | |
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 |
![]() | |
ObjBase (const char *name) | |
ObjBase constructor. More... | |
virtual | ~ObjBase () |
Destructor. More... | |
void | init () |
Object initializer. More... | |
Friends | |
class | FileUplinkComponentBaseFriend |
Friend class for white-box testing. More... | |
Additional Inherited Members | |
![]() | |
enum | { ACTIVE_COMPONENT_EXIT } |
![]() | |
enum | MsgDispatchStatus { MSG_DISPATCH_OK, MSG_DISPATCH_EMPTY, MSG_DISPATCH_ERROR, MSG_DISPATCH_EXIT } |
![]() | |
Os::Task | m_task |
task object for active component More... | |
![]() | |
Os::Queue | m_queue |
queue object for active component More... | |
Auto-generated base for FileUplink component.
A component for uplinking files
Definition at line 31 of file FileUplinkComponentAc.hpp.
|
protected |
Enumerations for numbers of typed input ports.
Enumerator | |
---|---|
NUM_BUFFERSENDIN_INPUT_PORTS | |
NUM_PINGIN_INPUT_PORTS |
Definition at line 49 of file FileUplinkComponentAc.hpp.
|
protected |
Enumerations for numbers of special output ports.
Enumerator | |
---|---|
NUM_LOGTEXT_OUTPUT_PORTS | |
NUM_EVENTOUT_OUTPUT_PORTS | |
NUM_TIMECALLER_OUTPUT_PORTS | |
NUM_TLMOUT_OUTPUT_PORTS |
Definition at line 55 of file FileUplinkComponentAc.hpp.
|
protected |
Enumerations for numbers of typed output ports.
Enumerator | |
---|---|
NUM_BUFFERSENDOUT_OUTPUT_PORTS | |
NUM_PINGOUT_OUTPUT_PORTS |
Definition at line 63 of file FileUplinkComponentAc.hpp.
|
protected |
Event IDs.
Definition at line 69 of file FileUplinkComponentAc.hpp.
|
protected |
Event throttle values: sets initial value of countdown variables.
Definition at line 83 of file FileUplinkComponentAc.hpp.
|
protected |
Channel IDs.
Enumerator | |
---|---|
CHANNELID_FILESRECEIVED | Channel ID for FilesReceived. |
CHANNELID_PACKETSRECEIVED | Channel ID for PacketsReceived. |
CHANNELID_WARNINGS | Channel ID for Warnings. |
Definition at line 92 of file FileUplinkComponentAc.hpp.
|
protected |
Construct FileUplinkComponentBase object.
compName | The component name |
Definition at line 485 of file FileUplinkComponentAc.cpp.
|
protectedvirtual |
Destroy FileUplinkComponentBase object.
Definition at line 496 of file FileUplinkComponentAc.cpp.
|
protectedpure virtual |
Handler for input port bufferSendIn.
portNum | The port number |
fwBuffer | The buffer |
|
protected |
Handler base-class function for input port bufferSendIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 650 of file FileUplinkComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port bufferSendIn.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 764 of file FileUplinkComponentAc.cpp.
|
protected |
Invoke output port bufferSendOut.
portNum | The port number |
fwBuffer | The buffer |
Definition at line 786 of file FileUplinkComponentAc.cpp.
Fw::InputBufferSendPort * Svc::FileUplinkComponentBase::get_bufferSendIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 259 of file FileUplinkComponentAc.cpp.
Svc::InputPingPort * Svc::FileUplinkComponentBase::get_pingIn_InputPort | ( | FwIndexType | portNum | ) |
Get typed input port at index
portNum | The port number |
Definition at line 270 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of bufferSendIn input ports
Definition at line 506 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of bufferSendOut output ports
Definition at line 554 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of eventOut output ports
Definition at line 532 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of pingIn input ports
Definition at line 512 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of pingOut output ports
Definition at line 560 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of timeCaller output ports
Definition at line 538 of file FileUplinkComponentAc.cpp.
|
protected |
Get the number of tlmOut output ports
Definition at line 544 of file FileUplinkComponentAc.cpp.
|
protected |
void Svc::FileUplinkComponentBase::init | ( | FwSizeType | queueDepth, |
FwEnumStoreType | instance = 0 |
||
) |
Initialize FileUplinkComponentBase object.
queueDepth | The queue depth |
instance | The instance number |
Definition at line 71 of file FileUplinkComponentAc.cpp.
|
protected |
Check whether port bufferSendOut is connected
portNum | The port number |
Definition at line 622 of file FileUplinkComponentAc.cpp.
|
protected |
Check whether port eventOut is connected
portNum | The port number |
Definition at line 585 of file FileUplinkComponentAc.cpp.
|
protected |
Check whether port pingOut is connected
portNum | The port number |
Definition at line 633 of file FileUplinkComponentAc.cpp.
|
protected |
Check whether port timeCaller is connected
portNum | The port number |
Definition at line 596 of file FileUplinkComponentAc.cpp.
|
protected |
Check whether port tlmOut is connected
portNum | The port number |
Definition at line 607 of file FileUplinkComponentAc.cpp.
|
protected |
Log event FileReceived
The File Uplink component successfully received a file
fileName | The name of the file |
Definition at line 1002 of file FileUplinkComponentAc.cpp.
|
protected |
Log event UplinkCanceled
The File Uplink component received a CANCEL packet
Definition at line 1564 of file FileUplinkComponentAc.cpp.
|
protected |
Log event BadChecksum
During receipt of a file, the computed checksum value did not match the stored value
fileName | The file name |
computed | The computed value |
read | The value read |
Definition at line 820 of file FileUplinkComponentAc.cpp.
|
protected |
Log event DecodeError
Error decoding file packet
status | The sequence index of the out-of-order packet |
Definition at line 1629 of file FileUplinkComponentAc.cpp.
|
protected |
Log event FileOpenError
An error occurred opening a file
fileName | The name of the file |
Definition at line 930 of file FileUplinkComponentAc.cpp.
|
protected |
Log event FileWriteError
An error occurred writing to a file
fileName | The name of the file |
Definition at line 1074 of file FileUplinkComponentAc.cpp.
|
protected |
Reset throttle value for FileWriteError.
Definition at line 1715 of file FileUplinkComponentAc.cpp.
|
protected |
Log event InvalidReceiveMode
The File Uplink component received a packet with a type that was invalid for the current receive mode
packetType | The type of the packet received |
mode | The receive mode |
Definition at line 1154 of file FileUplinkComponentAc.cpp.
|
protected |
Reset throttle value for InvalidReceiveMode.
Definition at line 1722 of file FileUplinkComponentAc.cpp.
|
protected |
Log event PacketDuplicate
The File Uplink component encountered a duplicate packet during file receipt
packetIndex | The sequence index of the duplicate packet |
Definition at line 1474 of file FileUplinkComponentAc.cpp.
|
protected |
Reset throttle value for PacketDuplicate.
Definition at line 1743 of file FileUplinkComponentAc.cpp.
|
protected |
Log event PacketOutOfBounds
During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file
packetIndex | The sequence index of the packet |
fileName | The name of the file |
Definition at line 1264 of file FileUplinkComponentAc.cpp.
|
protected |
Reset throttle value for PacketOutOfBounds.
Definition at line 1729 of file FileUplinkComponentAc.cpp.
|
protected |
Log event PacketOutOfOrder
The File Uplink component encountered an out-of-order packet during file receipt
packetIndex | The sequence index of the out-of-order packet |
lastPacketIndex | The sequence index of the last packet received before the out-of-order packet |
Definition at line 1364 of file FileUplinkComponentAc.cpp.
|
protected |
Reset throttle value for PacketOutOfOrder.
Definition at line 1736 of file FileUplinkComponentAc.cpp.
|
protectedpure virtual |
Handler for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
|
protected |
Handler base-class function for input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 703 of file FileUplinkComponentAc.cpp.
|
protectedvirtual |
Pre-message hook for async input port pingIn.
portNum | The port number |
key | Value to return to pinger |
Definition at line 773 of file FileUplinkComponentAc.cpp.
|
protected |
Invoke output port pingOut.
portNum | The port number |
key | Value to return to pinger |
Definition at line 801 of file FileUplinkComponentAc.cpp.
void Svc::FileUplinkComponentBase::set_bufferSendOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputBufferSendPort * | port | ||
) |
Connect port to bufferSendOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 349 of file FileUplinkComponentAc.cpp.
void Svc::FileUplinkComponentBase::set_eventOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputLogPort * | port | ||
) |
Connect port to eventOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 303 of file FileUplinkComponentAc.cpp.
void Svc::FileUplinkComponentBase::set_pingOut_OutputPort | ( | FwIndexType | portNum, |
Svc::InputPingPort * | port | ||
) |
Connect port to pingOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 363 of file FileUplinkComponentAc.cpp.
void Svc::FileUplinkComponentBase::set_timeCaller_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTimePort * | port | ||
) |
Connect port to timeCaller[portNum].
portNum | The port number |
port | The input port |
Definition at line 317 of file FileUplinkComponentAc.cpp.
void Svc::FileUplinkComponentBase::set_tlmOut_OutputPort | ( | FwIndexType | portNum, |
Fw::InputTlmPort * | port | ||
) |
Connect port to tlmOut[portNum].
portNum | The port number |
port | The input port |
Definition at line 331 of file FileUplinkComponentAc.cpp.
|
protected |
Write telemetry channel FilesReceived
The total number of complete files received
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1754 of file FileUplinkComponentAc.cpp.
|
protected |
Write telemetry channel PacketsReceived
The total number of packets received
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1787 of file FileUplinkComponentAc.cpp.
|
protected |
Write telemetry channel Warnings
The total number of warnings issued
arg | The telemetry value |
_tlmTime | Timestamp. Default: unspecified, request from getTime port |
Definition at line 1820 of file FileUplinkComponentAc.cpp.
|
friend |
Friend class for white-box testing.
Definition at line 40 of file FileUplinkComponentAc.hpp.