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

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

#include <Svc/FileUplink/FileUplinkComponentAc.hpp>

Inheritance diagram for Svc::FileUplinkComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::FileUplink

Public Member Functions

void init (FwSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize FileUplinkComponentBase object.
 
Fw::InputBufferSendPortget_bufferSendIn_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
void set_eventOut_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to eventOut[portNum].
 
void set_timeCaller_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to timeCaller[portNum].
 
void set_tlmOut_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to tlmOut[portNum].
 
void set_bufferSendOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferSendOut[portNum].
 
void set_pingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
 Connect port to pingOut[portNum].
 
- Public Member Functions inherited from Fw::ActiveComponentBase
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
 
void exit ()
 exit task in active component
 
Os::Task::Status join ()
 Join the thread.
 
 DEPRECATED (Os::Task::Status join(void **value_ptr), "Switch to .join()")
 Join to thread with discarded value_ptr.
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_BUFFERSENDIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  {
  EVENTID_BADCHECKSUM = 0x0 , EVENTID_FILEOPENERROR = 0x1 , EVENTID_FILERECEIVED = 0x2 , EVENTID_FILEWRITEERROR = 0x3 ,
  EVENTID_INVALIDRECEIVEMODE = 0x4 , EVENTID_PACKETOUTOFBOUNDS = 0x5 , EVENTID_PACKETOUTOFORDER = 0x6 , EVENTID_PACKETDUPLICATE = 0x7 ,
  EVENTID_UPLINKCANCELED = 0x8 , EVENTID_DECODEERROR = 0x9
}
 Event IDs. More...
 
enum  {
  EVENTID_FILEWRITEERROR_THROTTLE = 5 , EVENTID_INVALIDRECEIVEMODE_THROTTLE = 5 , EVENTID_PACKETOUTOFBOUNDS_THROTTLE = 5 , EVENTID_PACKETOUTOFORDER_THROTTLE = 20 ,
  EVENTID_PACKETDUPLICATE_THROTTLE = 20
}
 Event throttle values: sets initial value of countdown variables. More...
 
enum  { CHANNELID_FILESRECEIVED = 0x0 , CHANNELID_PACKETSRECEIVED = 0x1 , CHANNELID_WARNINGS = 0x2 }
 Channel IDs. More...
 
- Protected Types inherited from Fw::ActiveComponentBase
enum  Lifecycle { CREATED , DISPATCHING , FINALIZING , DONE }
 Tracks the lifecycle of the component. More...
 

Protected Member Functions

 FileUplinkComponentBase (const char *compName="")
 Construct FileUplinkComponentBase object.
 
virtual ~FileUplinkComponentBase ()
 Destroy FileUplinkComponentBase object.
 
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.
 
virtual void pingIn_handler (FwIndexType portNum, U32 key)=0
 Handler for input port pingIn.
 
void bufferSendIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port bufferSendIn.
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn.
 
virtual void bufferSendIn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Pre-message hook for async input port bufferSendIn.
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn.
 
void bufferSendOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferSendOut.
 
void pingOut_out (FwIndexType portNum, U32 key)
 Invoke output port pingOut.
 
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.
 
void log_WARNING_HI_InvalidReceiveMode_ThrottleClear ()
 Reset throttle value for InvalidReceiveMode.
 
void log_WARNING_HI_PacketOutOfBounds_ThrottleClear ()
 Reset throttle value for PacketOutOfBounds.
 
void log_WARNING_HI_PacketOutOfOrder_ThrottleClear ()
 Reset throttle value for PacketOutOfOrder.
 
void log_WARNING_HI_PacketDuplicate_ThrottleClear ()
 Reset throttle value for PacketDuplicate.
 
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 ()
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 ActiveComponentBase (const char *name)
 Constructor.
 
virtual ~ActiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization code
 
virtual void preamble ()
 A function that will be called before the event loop is entered.
 
MsgDispatchStatus dispatch ()
 The function that will dispatching messages.
 
virtual void finalizer ()
 A function that will be called after exiting the loop.
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 QueuedComponentBase (const char *name)
 Constructor.
 
virtual ~QueuedComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 initialization function
 
Os::Queue::Status createQueue (FwSizeType depth, FwSizeType msgSize)
 
NATIVE_INT_TYPE getNumMsgsDropped ()
 return number of messages dropped
 
void incNumMsgDropped ()
 increment the number of messages dropped
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 

Friends

class FileUplinkComponentBaseFriend
 Friend class for white-box testing.
 

Additional Inherited Members

- Public Types inherited from Fw::ActiveComponentBase
enum  { ACTIVE_COMPONENT_EXIT }
 
- Public Types inherited from Fw::QueuedComponentBase
enum  MsgDispatchStatus { MSG_DISPATCH_OK , MSG_DISPATCH_EMPTY , MSG_DISPATCH_ERROR , MSG_DISPATCH_EXIT }
 
- Protected Attributes inherited from Fw::ActiveComponentBase
Os::Task m_task
 task object for active component
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component
 

Detailed Description

Auto-generated base for FileUplink component.

A component for uplinking files

Definition at line 31 of file FileUplinkComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
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.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_BADCHECKSUM 

During receipt of a file, the computed checksum value did not match the stored value.

EVENTID_FILEOPENERROR 

An error occurred opening a file.

EVENTID_FILERECEIVED 

The File Uplink component successfully received a file.

EVENTID_FILEWRITEERROR 

An error occurred writing to a file.

EVENTID_INVALIDRECEIVEMODE 

The File Uplink component received a packet with a type that was invalid for the current receive mode.

EVENTID_PACKETOUTOFBOUNDS 

During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file.

EVENTID_PACKETOUTOFORDER 

The File Uplink component encountered an out-of-order packet during file receipt.

EVENTID_PACKETDUPLICATE 

The File Uplink component encountered a duplicate packet during file receipt.

EVENTID_UPLINKCANCELED 

The File Uplink component received a CANCEL packet.

EVENTID_DECODEERROR 

Error decoding file packet.

Definition at line 69 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event throttle values: sets initial value of countdown variables.

Enumerator
EVENTID_FILEWRITEERROR_THROTTLE 

Throttle reset count for FileWriteError.

EVENTID_INVALIDRECEIVEMODE_THROTTLE 

Throttle reset count for InvalidReceiveMode.

EVENTID_PACKETOUTOFBOUNDS_THROTTLE 

Throttle reset count for PacketOutOfBounds.

EVENTID_PACKETOUTOFORDER_THROTTLE 

Throttle reset count for PacketOutOfOrder.

EVENTID_PACKETDUPLICATE_THROTTLE 

Throttle reset count for PacketDuplicate.

Definition at line 83 of file FileUplinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
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.

Constructor & Destructor Documentation

◆ FileUplinkComponentBase()

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

Construct FileUplinkComponentBase object.

Parameters
compNameThe component name

Definition at line 484 of file FileUplinkComponentAc.cpp.

◆ ~FileUplinkComponentBase()

Svc::FileUplinkComponentBase::~FileUplinkComponentBase ( )
protectedvirtual

Destroy FileUplinkComponentBase object.

Definition at line 495 of file FileUplinkComponentAc.cpp.

Member Function Documentation

◆ bufferSendIn_handler()

virtual void Svc::FileUplinkComponentBase::bufferSendIn_handler ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port bufferSendIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ bufferSendIn_handlerBase()

void Svc::FileUplinkComponentBase::bufferSendIn_handlerBase ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port bufferSendIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 649 of file FileUplinkComponentAc.cpp.

◆ bufferSendIn_preMsgHook()

void Svc::FileUplinkComponentBase::bufferSendIn_preMsgHook ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedvirtual

Pre-message hook for async input port bufferSendIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 763 of file FileUplinkComponentAc.cpp.

◆ bufferSendOut_out()

void Svc::FileUplinkComponentBase::bufferSendOut_out ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port bufferSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 785 of file FileUplinkComponentAc.cpp.

◆ get_bufferSendIn_InputPort()

Fw::InputBufferSendPort * Svc::FileUplinkComponentBase::get_bufferSendIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
bufferSendIn[portNum]
Parameters
portNumThe port number

Definition at line 258 of file FileUplinkComponentAc.cpp.

◆ get_pingIn_InputPort()

Svc::InputPingPort * Svc::FileUplinkComponentBase::get_pingIn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
pingIn[portNum]
Parameters
portNumThe port number

Definition at line 269 of file FileUplinkComponentAc.cpp.

◆ getNum_bufferSendIn_InputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_bufferSendIn_InputPorts ( ) const
protected

Get the number of bufferSendIn input ports

Returns
The number of bufferSendIn input ports

Definition at line 505 of file FileUplinkComponentAc.cpp.

◆ getNum_bufferSendOut_OutputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_bufferSendOut_OutputPorts ( ) const
protected

Get the number of bufferSendOut output ports

Returns
The number of bufferSendOut output ports

Definition at line 553 of file FileUplinkComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_eventOut_OutputPorts ( ) const
protected

Get the number of eventOut output ports

Returns
The number of eventOut output ports

Definition at line 531 of file FileUplinkComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_pingIn_InputPorts ( ) const
protected

Get the number of pingIn input ports

Returns
The number of pingIn input ports

Definition at line 511 of file FileUplinkComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_pingOut_OutputPorts ( ) const
protected

Get the number of pingOut output ports

Returns
The number of pingOut output ports

Definition at line 559 of file FileUplinkComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_timeCaller_OutputPorts ( ) const
protected

Get the number of timeCaller output ports

Returns
The number of timeCaller output ports

Definition at line 537 of file FileUplinkComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

FwIndexType Svc::FileUplinkComponentBase::getNum_tlmOut_OutputPorts ( ) const
protected

Get the number of tlmOut output ports

Returns
The number of tlmOut output ports

Definition at line 543 of file FileUplinkComponentAc.cpp.

◆ getTime()

Fw::Time Svc::FileUplinkComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1856 of file FileUplinkComponentAc.cpp.

◆ init()

void Svc::FileUplinkComponentBase::init ( FwSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize FileUplinkComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 70 of file FileUplinkComponentAc.cpp.

◆ isConnected_bufferSendOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_bufferSendOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port bufferSendOut is connected

Returns
Whether port bufferSendOut is connected
Parameters
portNumThe port number

Definition at line 621 of file FileUplinkComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_eventOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port eventOut is connected

Returns
Whether port eventOut is connected
Parameters
portNumThe port number

Definition at line 584 of file FileUplinkComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_pingOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port pingOut is connected

Returns
Whether port pingOut is connected
Parameters
portNumThe port number

Definition at line 632 of file FileUplinkComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_timeCaller_OutputPort ( FwIndexType  portNum)
protected

Check whether port timeCaller is connected

Returns
Whether port timeCaller is connected
Parameters
portNumThe port number

Definition at line 595 of file FileUplinkComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::FileUplinkComponentBase::isConnected_tlmOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port tlmOut is connected

Returns
Whether port tlmOut is connected
Parameters
portNumThe port number

Definition at line 606 of file FileUplinkComponentAc.cpp.

◆ log_ACTIVITY_HI_FileReceived()

void Svc::FileUplinkComponentBase::log_ACTIVITY_HI_FileReceived ( const Fw::StringBase fileName) const
protected

Log event FileReceived

The File Uplink component successfully received a file

Parameters
fileNameThe name of the file

Definition at line 1001 of file FileUplinkComponentAc.cpp.

◆ log_ACTIVITY_HI_UplinkCanceled()

void Svc::FileUplinkComponentBase::log_ACTIVITY_HI_UplinkCanceled ( ) const
protected

Log event UplinkCanceled

The File Uplink component received a CANCEL packet

Definition at line 1563 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_BadChecksum()

void Svc::FileUplinkComponentBase::log_WARNING_HI_BadChecksum ( const Fw::StringBase fileName,
U32  computed,
U32  read 
) const
protected

Log event BadChecksum

During receipt of a file, the computed checksum value did not match the stored value

Parameters
fileNameThe file name
computedThe computed value
readThe value read

Definition at line 819 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_DecodeError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_DecodeError ( I32  status) const
protected

Log event DecodeError

Error decoding file packet

Parameters
statusThe sequence index of the out-of-order packet

Definition at line 1628 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileOpenError ( const Fw::StringBase fileName) const
protected

Log event FileOpenError

An error occurred opening a file

Parameters
fileNameThe name of the file

Definition at line 929 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileWriteError ( const Fw::StringBase fileName)
protected

Log event FileWriteError

An error occurred writing to a file

Parameters
fileNameThe name of the file

Definition at line 1073 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_FileWriteError_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_FileWriteError_ThrottleClear ( )
protected

Reset throttle value for FileWriteError.

Definition at line 1714 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_InvalidReceiveMode()

void Svc::FileUplinkComponentBase::log_WARNING_HI_InvalidReceiveMode ( U32  packetType,
U32  mode 
)
protected

Log event InvalidReceiveMode

The File Uplink component received a packet with a type that was invalid for the current receive mode

Parameters
packetTypeThe type of the packet received
modeThe receive mode

Definition at line 1153 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_InvalidReceiveMode_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_InvalidReceiveMode_ThrottleClear ( )
protected

Reset throttle value for InvalidReceiveMode.

Definition at line 1721 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketDuplicate()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketDuplicate ( U32  packetIndex)
protected

Log event PacketDuplicate

The File Uplink component encountered a duplicate packet during file receipt

Parameters
packetIndexThe sequence index of the duplicate packet

Definition at line 1473 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketDuplicate_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketDuplicate_ThrottleClear ( )
protected

Reset throttle value for PacketDuplicate.

Definition at line 1742 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfBounds()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfBounds ( U32  packetIndex,
const Fw::StringBase fileName 
)
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

Parameters
packetIndexThe sequence index of the packet
fileNameThe name of the file

Definition at line 1263 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfBounds_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfBounds_ThrottleClear ( )
protected

Reset throttle value for PacketOutOfBounds.

Definition at line 1728 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfOrder()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfOrder ( U32  packetIndex,
U32  lastPacketIndex 
)
protected

Log event PacketOutOfOrder

The File Uplink component encountered an out-of-order packet during file receipt

Parameters
packetIndexThe sequence index of the out-of-order packet
lastPacketIndexThe sequence index of the last packet received before the out-of-order packet

Definition at line 1363 of file FileUplinkComponentAc.cpp.

◆ log_WARNING_HI_PacketOutOfOrder_ThrottleClear()

void Svc::FileUplinkComponentBase::log_WARNING_HI_PacketOutOfOrder_ThrottleClear ( )
protected

Reset throttle value for PacketOutOfOrder.

Definition at line 1735 of file FileUplinkComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::FileUplinkComponentBase::pingIn_handler ( FwIndexType  portNum,
U32  key 
)
protectedpure virtual

Handler for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

◆ pingIn_handlerBase()

void Svc::FileUplinkComponentBase::pingIn_handlerBase ( FwIndexType  portNum,
U32  key 
)
protected

Handler base-class function for input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 702 of file FileUplinkComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::FileUplinkComponentBase::pingIn_preMsgHook ( FwIndexType  portNum,
U32  key 
)
protectedvirtual

Pre-message hook for async input port pingIn.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 772 of file FileUplinkComponentAc.cpp.

◆ pingOut_out()

void Svc::FileUplinkComponentBase::pingOut_out ( FwIndexType  portNum,
U32  key 
)
protected

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 800 of file FileUplinkComponentAc.cpp.

◆ set_bufferSendOut_OutputPort()

void Svc::FileUplinkComponentBase::set_bufferSendOut_OutputPort ( FwIndexType  portNum,
Fw::InputBufferSendPort port 
)

Connect port to bufferSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 348 of file FileUplinkComponentAc.cpp.

◆ set_eventOut_OutputPort()

void Svc::FileUplinkComponentBase::set_eventOut_OutputPort ( FwIndexType  portNum,
Fw::InputLogPort port 
)

Connect port to eventOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 302 of file FileUplinkComponentAc.cpp.

◆ set_pingOut_OutputPort()

void Svc::FileUplinkComponentBase::set_pingOut_OutputPort ( FwIndexType  portNum,
Svc::InputPingPort port 
)

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 362 of file FileUplinkComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 316 of file FileUplinkComponentAc.cpp.

◆ set_tlmOut_OutputPort()

void Svc::FileUplinkComponentBase::set_tlmOut_OutputPort ( FwIndexType  portNum,
Fw::InputTlmPort port 
)

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 330 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_FilesReceived()

void Svc::FileUplinkComponentBase::tlmWrite_FilesReceived ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel FilesReceived

The total number of complete files received

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1753 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_PacketsReceived()

void Svc::FileUplinkComponentBase::tlmWrite_PacketsReceived ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel PacketsReceived

The total number of packets received

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1786 of file FileUplinkComponentAc.cpp.

◆ tlmWrite_Warnings()

void Svc::FileUplinkComponentBase::tlmWrite_Warnings ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
) const
protected

Write telemetry channel Warnings

The total number of warnings issued

Parameters
argThe telemetry value
_tlmTimeTimestamp. Default: unspecified, request from getTime port

Definition at line 1819 of file FileUplinkComponentAc.cpp.

Friends And Related Symbol Documentation

◆ FileUplinkComponentBaseFriend

friend class FileUplinkComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 40 of file FileUplinkComponentAc.hpp.


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