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

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

#include <Svc/FileDownlink/FileDownlinkComponentAc.hpp>

Inheritance diagram for Svc::FileDownlinkComponentBase:
Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase Svc::FileDownlink

Public Member Functions

void init (FwQueueSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize FileDownlinkComponentBase object. More...
 
Fw::InputCmdPortget_cmdIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_Run_InputPort (FwIndexType portNum)
 
Svc::InputSendFileRequestPortget_SendFile_InputPort (FwIndexType portNum)
 
Fw::InputBufferSendPortget_bufferReturn_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_pingIn_InputPort (FwIndexType portNum)
 
void set_cmdRegOut_OutputPort (FwIndexType portNum, Fw::InputCmdRegPort *port)
 Connect port to cmdRegOut[portNum]. More...
 
void set_cmdResponseOut_OutputPort (FwIndexType portNum, Fw::InputCmdResponsePort *port)
 Connect port to cmdResponseOut[portNum]. More...
 
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_FileComplete_OutputPort (FwIndexType portNum, Svc::InputSendFileCompletePort *port)
 Connect port to FileComplete[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 regCommands ()
 Register commands with the Command Dispatcher. More...
 
- 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 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...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_CMDIN_INPUT_PORTS = 1 }
 Enumerations for numbers of special input ports. More...
 
enum  { NUM_RUN_INPUT_PORTS = 1 , NUM_SENDFILE_INPUT_PORTS = 1 , NUM_BUFFERRETURN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  {
  NUM_CMDREGOUT_OUTPUT_PORTS = 1 , NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1 , NUM_EVENTOUT_OUTPUT_PORTS = 1 , NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1 ,
  NUM_TIMECALLER_OUTPUT_PORTS = 1 , NUM_TLMOUT_OUTPUT_PORTS = 1
}
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_FILECOMPLETE_OUTPUT_PORTS = 1 , NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { OPCODE_SENDFILE = 0x0 , OPCODE_CANCEL = 0x1 , OPCODE_SENDPARTIAL = 0x2 }
 Command opcodes. More...
 
enum  {
  EVENTID_FILEOPENERROR = 0x0 , EVENTID_FILEREADERROR = 0x1 , EVENTID_FILESENT = 0x2 , EVENTID_DOWNLINKCANCELED = 0x3 ,
  EVENTID_DOWNLINKTIMEOUT = 0x4 , EVENTID_DOWNLINKPARTIALWARNING = 0x5 , EVENTID_DOWNLINKPARTIALFAIL = 0x6 , EVENTID_SENDDATAFAIL = 0x7 ,
  EVENTID_SENDSTARTED = 0x8
}
 Event IDs. More...
 
enum  { CHANNELID_FILESSENT = 0x0 , CHANNELID_PACKETSSENT = 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

 FileDownlinkComponentBase (const char *compName="")
 Construct FileDownlinkComponentBase object. More...
 
virtual ~FileDownlinkComponentBase ()
 Destroy FileDownlinkComponentBase object. More...
 
FwIndexType getNum_cmdIn_InputPorts () const
 
FwIndexType getNum_Run_InputPorts () const
 
FwIndexType getNum_SendFile_InputPorts () const
 
FwIndexType getNum_bufferReturn_InputPorts () const
 
FwIndexType getNum_pingIn_InputPorts () const
 
FwIndexType getNum_cmdRegOut_OutputPorts () const
 
FwIndexType getNum_cmdResponseOut_OutputPorts () const
 
FwIndexType getNum_eventOut_OutputPorts () const
 
FwIndexType getNum_timeCaller_OutputPorts () const
 
FwIndexType getNum_tlmOut_OutputPorts () const
 
FwIndexType getNum_FileComplete_OutputPorts () const
 
FwIndexType getNum_bufferSendOut_OutputPorts () const
 
FwIndexType getNum_pingOut_OutputPorts () const
 
bool isConnected_cmdRegOut_OutputPort (FwIndexType portNum)
 
bool isConnected_cmdResponseOut_OutputPort (FwIndexType portNum)
 
bool isConnected_eventOut_OutputPort (FwIndexType portNum)
 
bool isConnected_timeCaller_OutputPort (FwIndexType portNum)
 
bool isConnected_tlmOut_OutputPort (FwIndexType portNum)
 
bool isConnected_FileComplete_OutputPort (FwIndexType portNum)
 
bool isConnected_bufferSendOut_OutputPort (FwIndexType portNum)
 
bool isConnected_pingOut_OutputPort (FwIndexType portNum)
 
virtual void Run_handler (FwIndexType portNum, U32 context)=0
 Handler for input port Run. More...
 
virtual Svc::SendFileResponse SendFile_handler (FwIndexType portNum, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)=0
 Handler for input port SendFile. More...
 
virtual void bufferReturn_handler (FwIndexType portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port bufferReturn. More...
 
virtual void pingIn_handler (FwIndexType portNum, U32 key)=0
 Handler for input port pingIn. More...
 
void Run_handlerBase (FwIndexType portNum, U32 context)
 Handler base-class function for input port Run. More...
 
Svc::SendFileResponse SendFile_handlerBase (FwIndexType portNum, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)
 Handler base-class function for input port SendFile. More...
 
void bufferReturn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port bufferReturn. More...
 
void pingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port pingIn. More...
 
virtual void Run_preMsgHook (FwIndexType portNum, U32 context)
 Pre-message hook for async input port Run. More...
 
virtual void bufferReturn_preMsgHook (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Pre-message hook for async input port bufferReturn. More...
 
virtual void pingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port pingIn. More...
 
void FileComplete_out (FwIndexType portNum, const Svc::SendFileResponse &resp)
 Invoke output port FileComplete. 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 cmdResponse_out (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdResponse response)
 Emit command response. More...
 
virtual void SendFile_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &sourceFileName, const Fw::CmdStringArg &destFileName)=0
 
virtual void Cancel_cmdHandler (FwOpcodeType opCode, U32 cmdSeq)=0
 
virtual void SendPartial_cmdHandler (FwOpcodeType opCode, U32 cmdSeq, const Fw::CmdStringArg &sourceFileName, const Fw::CmdStringArg &destFileName, U32 startOffset, U32 length)=0
 
void SendFile_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void Cancel_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
void SendPartial_cmdHandlerBase (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 
virtual void SendFile_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command SendFile. More...
 
virtual void Cancel_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command Cancel. More...
 
virtual void SendPartial_preMsgHook (FwOpcodeType opCode, U32 cmdSeq)
 Pre-message hook for command SendPartial. More...
 
void log_WARNING_HI_FileOpenError (const Fw::StringBase &fileName)
 
void log_WARNING_HI_FileReadError (const Fw::StringBase &fileName, I32 status)
 
void log_ACTIVITY_HI_FileSent (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_ACTIVITY_HI_DownlinkCanceled (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_WARNING_HI_DownlinkTimeout (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_WARNING_LO_DownlinkPartialWarning (U32 startOffset, U32 length, U32 filesize, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void log_WARNING_HI_DownlinkPartialFail (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 startOffset, U32 filesize)
 
void log_WARNING_HI_SendDataFail (const Fw::StringBase &sourceFileName, U32 byteOffset)
 
void log_ACTIVITY_HI_SendStarted (U32 fileSize, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName)
 
void tlmWrite_FilesSent (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_PacketsSent (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
void tlmWrite_Warnings (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
Fw::Time getTime ()
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. More...
 
- Protected Member Functions inherited from Fw::ActiveComponentBase
 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...
 
- Protected Member Functions inherited from Fw::QueuedComponentBase
 QueuedComponentBase (const char *name)
 Constructor. More...
 
virtual ~QueuedComponentBase ()
 Destructor. More...
 
void init (NATIVE_INT_TYPE instance)
 initialization function More...
 
Os::Queue::QueueStatus createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE msgSize)
 
NATIVE_INT_TYPE getNumMsgsDropped ()
 return number of messages dropped More...
 
void incNumMsgDropped ()
 increment the number of messages dropped 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 FileDownlinkComponentBaseFriend
 Friend class for white-box testing. More...
 

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 More...
 
- Protected Attributes inherited from Fw::QueuedComponentBase
Os::Queue m_queue
 queue object for active component More...
 

Detailed Description

Auto-generated base for FileDownlink component.

A component for downlinking files

Definition at line 39 of file FileDownlinkComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special input ports.

Enumerator
NUM_CMDIN_INPUT_PORTS 

Definition at line 57 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_RUN_INPUT_PORTS 
NUM_SENDFILE_INPUT_PORTS 
NUM_BUFFERRETURN_INPUT_PORTS 
NUM_PINGIN_INPUT_PORTS 

Definition at line 62 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_CMDREGOUT_OUTPUT_PORTS 
NUM_CMDRESPONSEOUT_OUTPUT_PORTS 
NUM_EVENTOUT_OUTPUT_PORTS 
NUM_TEXTEVENTOUT_OUTPUT_PORTS 
NUM_TIMECALLER_OUTPUT_PORTS 
NUM_TLMOUT_OUTPUT_PORTS 

Definition at line 70 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_FILECOMPLETE_OUTPUT_PORTS 
NUM_BUFFERSENDOUT_OUTPUT_PORTS 
NUM_PINGOUT_OUTPUT_PORTS 

Definition at line 80 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Command opcodes.

Enumerator
OPCODE_SENDFILE 

Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.

OPCODE_CANCEL 

Cancel the downlink in progress, if any.

OPCODE_SENDPARTIAL 

Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Definition at line 87 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_FILEOPENERROR 

An error occurred opening a file.

EVENTID_FILEREADERROR 

An error occurred reading a file.

EVENTID_FILESENT 

The File Downlink component successfully sent a file.

EVENTID_DOWNLINKCANCELED 

The File Downlink component canceled downlink of a file.

EVENTID_DOWNLINKTIMEOUT 

The File Downlink component has detected a timeout. Downlink has been canceled.

EVENTID_DOWNLINKPARTIALWARNING 

The File Downlink component has detected a timeout. Downlink has been canceled.

EVENTID_DOWNLINKPARTIALFAIL 

The File Downlink component has detected a timeout. Downlink has been canceled.

EVENTID_SENDDATAFAIL 

The File Downlink component generated an error when trying to send a data packet.

EVENTID_SENDSTARTED 

The File Downlink component started a file download.

Definition at line 94 of file FileDownlinkComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Channel IDs.

Enumerator
CHANNELID_FILESSENT 

Channel ID for FilesSent.

CHANNELID_PACKETSSENT 

Channel ID for PacketsSent.

CHANNELID_WARNINGS 

Channel ID for Warnings.

Definition at line 107 of file FileDownlinkComponentAc.hpp.

Constructor & Destructor Documentation

◆ FileDownlinkComponentBase()

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

Construct FileDownlinkComponentBase object.

Parameters
compNameThe component name

Definition at line 760 of file FileDownlinkComponentAc.cpp.

◆ ~FileDownlinkComponentBase()

Svc::FileDownlinkComponentBase::~FileDownlinkComponentBase ( )
protectedvirtual

Destroy FileDownlinkComponentBase object.

Definition at line 767 of file FileDownlinkComponentAc.cpp.

Member Function Documentation

◆ bufferReturn_handler()

virtual void Svc::FileDownlinkComponentBase::bufferReturn_handler ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port bufferReturn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ bufferReturn_handlerBase()

void Svc::FileDownlinkComponentBase::bufferReturn_handlerBase ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port bufferReturn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1082 of file FileDownlinkComponentAc.cpp.

◆ bufferReturn_preMsgHook()

void Svc::FileDownlinkComponentBase::bufferReturn_preMsgHook ( FwIndexType  portNum,
Fw::Buffer fwBuffer 
)
protectedvirtual

Pre-message hook for async input port bufferReturn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1205 of file FileDownlinkComponentAc.cpp.

◆ bufferSendOut_out()

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

Invoke output port bufferSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1242 of file FileDownlinkComponentAc.cpp.

◆ Cancel_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::Cancel_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedpure virtual

Handler for command Cancel

Cancel the downlink in progress, if any

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

◆ Cancel_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::Cancel_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command Cancel

Cancel the downlink in progress, if any

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1352 of file FileDownlinkComponentAc.cpp.

◆ Cancel_preMsgHook()

void Svc::FileDownlinkComponentBase::Cancel_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command Cancel.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1489 of file FileDownlinkComponentAc.cpp.

◆ cmdResponse_out()

void Svc::FileDownlinkComponentBase::cmdResponse_out ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdResponse  response 
)
protected

Emit command response.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
responseThe command response

Definition at line 1276 of file FileDownlinkComponentAc.cpp.

◆ FileComplete_out()

void Svc::FileDownlinkComponentBase::FileComplete_out ( FwIndexType  portNum,
const Svc::SendFileResponse resp 
)
protected

Invoke output port FileComplete.

Parameters
portNumThe port number

Definition at line 1227 of file FileDownlinkComponentAc.cpp.

◆ get_bufferReturn_InputPort()

Fw::InputBufferSendPort * Svc::FileDownlinkComponentBase::get_bufferReturn_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
bufferReturn[portNum]
Parameters
portNumThe port number

Definition at line 428 of file FileDownlinkComponentAc.cpp.

◆ get_cmdIn_InputPort()

Fw::InputCmdPort * Svc::FileDownlinkComponentBase::get_cmdIn_InputPort ( FwIndexType  portNum)

Get special input port at index

Returns
cmdIn[portNum]
Parameters
portNumThe port number

Definition at line 391 of file FileDownlinkComponentAc.cpp.

◆ get_pingIn_InputPort()

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

Get typed input port at index

Returns
pingIn[portNum]
Parameters
portNumThe port number

Definition at line 439 of file FileDownlinkComponentAc.cpp.

◆ get_Run_InputPort()

Svc::InputSchedPort * Svc::FileDownlinkComponentBase::get_Run_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
Run[portNum]
Parameters
portNumThe port number

Definition at line 406 of file FileDownlinkComponentAc.cpp.

◆ get_SendFile_InputPort()

Svc::InputSendFileRequestPort * Svc::FileDownlinkComponentBase::get_SendFile_InputPort ( FwIndexType  portNum)

Get typed input port at index

Returns
SendFile[portNum]
Parameters
portNumThe port number

Definition at line 417 of file FileDownlinkComponentAc.cpp.

◆ getNum_bufferReturn_InputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_bufferReturn_InputPorts ( ) const
protected

Get the number of bufferReturn input ports

Returns
The number of bufferReturn input ports

Definition at line 799 of file FileDownlinkComponentAc.cpp.

◆ getNum_bufferSendOut_OutputPorts()

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

Get the number of bufferSendOut output ports

Returns
The number of bufferSendOut output ports

Definition at line 865 of file FileDownlinkComponentAc.cpp.

◆ getNum_cmdIn_InputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_cmdIn_InputPorts ( ) const
protected

Get the number of cmdIn input ports

Returns
The number of cmdIn input ports

Definition at line 777 of file FileDownlinkComponentAc.cpp.

◆ getNum_cmdRegOut_OutputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_cmdRegOut_OutputPorts ( ) const
protected

Get the number of cmdRegOut output ports

Returns
The number of cmdRegOut output ports

Definition at line 815 of file FileDownlinkComponentAc.cpp.

◆ getNum_cmdResponseOut_OutputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_cmdResponseOut_OutputPorts ( ) const
protected

Get the number of cmdResponseOut output ports

Returns
The number of cmdResponseOut output ports

Definition at line 821 of file FileDownlinkComponentAc.cpp.

◆ getNum_eventOut_OutputPorts()

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

Get the number of eventOut output ports

Returns
The number of eventOut output ports

Definition at line 827 of file FileDownlinkComponentAc.cpp.

◆ getNum_FileComplete_OutputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_FileComplete_OutputPorts ( ) const
protected

Get the number of FileComplete output ports

Returns
The number of FileComplete output ports

Definition at line 859 of file FileDownlinkComponentAc.cpp.

◆ getNum_pingIn_InputPorts()

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

Get the number of pingIn input ports

Returns
The number of pingIn input ports

Definition at line 805 of file FileDownlinkComponentAc.cpp.

◆ getNum_pingOut_OutputPorts()

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

Get the number of pingOut output ports

Returns
The number of pingOut output ports

Definition at line 871 of file FileDownlinkComponentAc.cpp.

◆ getNum_Run_InputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_Run_InputPorts ( ) const
protected

Get the number of Run input ports

Returns
The number of Run input ports

Definition at line 787 of file FileDownlinkComponentAc.cpp.

◆ getNum_SendFile_InputPorts()

FwIndexType Svc::FileDownlinkComponentBase::getNum_SendFile_InputPorts ( ) const
protected

Get the number of SendFile input ports

Returns
The number of SendFile input ports

Definition at line 793 of file FileDownlinkComponentAc.cpp.

◆ getNum_timeCaller_OutputPorts()

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

Get the number of timeCaller output ports

Returns
The number of timeCaller output ports

Definition at line 843 of file FileDownlinkComponentAc.cpp.

◆ getNum_tlmOut_OutputPorts()

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

Get the number of tlmOut output ports

Returns
The number of tlmOut output ports

Definition at line 849 of file FileDownlinkComponentAc.cpp.

◆ getTime()

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

Get the time

\return The current time

Definition at line 2478 of file FileDownlinkComponentAc.cpp.

◆ init()

void Svc::FileDownlinkComponentBase::init ( FwQueueSizeType  queueDepth,
FwEnumStoreType  instance = 0 
)

Initialize FileDownlinkComponentBase object.

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 75 of file FileDownlinkComponentAc.cpp.

◆ isConnected_bufferSendOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 966 of file FileDownlinkComponentAc.cpp.

◆ isConnected_cmdRegOut_OutputPort()

bool Svc::FileDownlinkComponentBase::isConnected_cmdRegOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdRegOut is connected

Returns
Whether port cmdRegOut is connected
Parameters
portNumThe port number

Definition at line 881 of file FileDownlinkComponentAc.cpp.

◆ isConnected_cmdResponseOut_OutputPort()

bool Svc::FileDownlinkComponentBase::isConnected_cmdResponseOut_OutputPort ( FwIndexType  portNum)
protected

Check whether port cmdResponseOut is connected

Returns
Whether port cmdResponseOut is connected
Parameters
portNumThe port number

Definition at line 892 of file FileDownlinkComponentAc.cpp.

◆ isConnected_eventOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 903 of file FileDownlinkComponentAc.cpp.

◆ isConnected_FileComplete_OutputPort()

bool Svc::FileDownlinkComponentBase::isConnected_FileComplete_OutputPort ( FwIndexType  portNum)
protected

Check whether port FileComplete is connected

Returns
Whether port FileComplete is connected
Parameters
portNumThe port number

Definition at line 955 of file FileDownlinkComponentAc.cpp.

◆ isConnected_pingOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 977 of file FileDownlinkComponentAc.cpp.

◆ isConnected_timeCaller_OutputPort()

bool Svc::FileDownlinkComponentBase::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 929 of file FileDownlinkComponentAc.cpp.

◆ isConnected_tlmOut_OutputPort()

bool Svc::FileDownlinkComponentBase::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 940 of file FileDownlinkComponentAc.cpp.

◆ lock()

void Svc::FileDownlinkComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 2498 of file FileDownlinkComponentAc.cpp.

◆ log_ACTIVITY_HI_DownlinkCanceled()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_DownlinkCanceled ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
)
protected

Log event DownlinkCanceled

The File Downlink component canceled downlink of a file

Parameters
sourceFileNameThe source file name
destFileNameThe destination file name

Definition at line 1761 of file FileDownlinkComponentAc.cpp.

◆ log_ACTIVITY_HI_FileSent()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_FileSent ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
)
protected

Log event FileSent

The File Downlink component successfully sent a file

Parameters
sourceFileNameThe source file name
destFileNameThe destination file name

Definition at line 1679 of file FileDownlinkComponentAc.cpp.

◆ log_ACTIVITY_HI_SendStarted()

void Svc::FileDownlinkComponentBase::log_ACTIVITY_HI_SendStarted ( U32  fileSize,
const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
)
protected

Log event SendStarted

The File Downlink component started a file download.

Parameters
fileSizeThe source file size
sourceFileNameThe source filename
destFileNameThe destination filename

Definition at line 2271 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_HI_DownlinkPartialFail()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_DownlinkPartialFail ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName,
U32  startOffset,
U32  filesize 
)
protected

Log event DownlinkPartialFail

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters
sourceFileNameThe source filename
destFileNameThe destination file name
startOffsetStarting file offset in bytes
filesizeSize of source file

Definition at line 2061 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_HI_DownlinkTimeout()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_DownlinkTimeout ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
)
protected

Log event DownlinkTimeout

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters
sourceFileNameThe source filename
destFileNameThe destination file name

Definition at line 1843 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_HI_FileOpenError()

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

Log event FileOpenError

An error occurred opening a file

Parameters
fileNameThe name of the file

Definition at line 1515 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_HI_FileReadError()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_FileReadError ( const Fw::StringBase fileName,
I32  status 
)
protected

Log event FileReadError

An error occurred reading a file

Parameters
fileNameThe name of the file
statusThe file status of read

Definition at line 1587 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_HI_SendDataFail()

void Svc::FileDownlinkComponentBase::log_WARNING_HI_SendDataFail ( const Fw::StringBase sourceFileName,
U32  byteOffset 
)
protected

Log event SendDataFail

The File Downlink component generated an error when trying to send a data packet.

Parameters
sourceFileNameThe source filename
byteOffsetByte offset

Definition at line 2179 of file FileDownlinkComponentAc.cpp.

◆ log_WARNING_LO_DownlinkPartialWarning()

void Svc::FileDownlinkComponentBase::log_WARNING_LO_DownlinkPartialWarning ( U32  startOffset,
U32  length,
U32  filesize,
const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName 
)
protected

Log event DownlinkPartialWarning

The File Downlink component has detected a timeout. Downlink has been canceled.

Parameters
startOffsetStarting file offset in bytes
lengthNumber of bytes to downlink
filesizeSize of source file
sourceFileNameThe source filename
destFileNameThe destination file name

Definition at line 1925 of file FileDownlinkComponentAc.cpp.

◆ pingIn_handler()

virtual void Svc::FileDownlinkComponentBase::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::FileDownlinkComponentBase::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 1135 of file FileDownlinkComponentAc.cpp.

◆ pingIn_preMsgHook()

void Svc::FileDownlinkComponentBase::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 1214 of file FileDownlinkComponentAc.cpp.

◆ pingOut_out()

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

Invoke output port pingOut.

Parameters
portNumThe port number
keyValue to return to pinger

Definition at line 1257 of file FileDownlinkComponentAc.cpp.

◆ regCommands()

void Svc::FileDownlinkComponentBase::regCommands ( )

Register commands with the Command Dispatcher.

Connect the dispatcher first

Definition at line 738 of file FileDownlinkComponentAc.cpp.

◆ Run_handler()

virtual void Svc::FileDownlinkComponentBase::Run_handler ( FwIndexType  portNum,
U32  context 
)
protectedpure virtual

Handler for input port Run.

Parameters
portNumThe port number
contextThe call order

◆ Run_handlerBase()

void Svc::FileDownlinkComponentBase::Run_handlerBase ( FwIndexType  portNum,
U32  context 
)
protected

Handler base-class function for input port Run.

Parameters
portNumThe port number
contextThe call order

Definition at line 994 of file FileDownlinkComponentAc.cpp.

◆ Run_preMsgHook()

void Svc::FileDownlinkComponentBase::Run_preMsgHook ( FwIndexType  portNum,
U32  context 
)
protectedvirtual

Pre-message hook for async input port Run.

Parameters
portNumThe port number
contextThe call order

Definition at line 1196 of file FileDownlinkComponentAc.cpp.

◆ SendFile_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::SendFile_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg sourceFileName,
const Fw::CmdStringArg destFileName 
)
protectedpure virtual

Handler for command SendFile

Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
sourceFileNameThe name of the on-board file to send
destFileNameThe name of the destination file on the ground

◆ SendFile_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::SendFile_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command SendFile

Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1293 of file FileDownlinkComponentAc.cpp.

◆ SendFile_handler()

virtual Svc::SendFileResponse Svc::FileDownlinkComponentBase::SendFile_handler ( FwIndexType  portNum,
const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName,
U32  offset,
U32  length 
)
protectedpure virtual

Handler for input port SendFile.

Parameters
portNumThe port number
sourceFileNamePath of file to downlink
destFileNamePath to store downlinked file at
offsetAmount of data in bytes to downlink from file. 0 to read until end of file
lengthAmount of data in bytes to downlink from file. 0 to read until end of file

◆ SendFile_handlerBase()

Svc::SendFileResponse Svc::FileDownlinkComponentBase::SendFile_handlerBase ( FwIndexType  portNum,
const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName,
U32  offset,
U32  length 
)
protected

Handler base-class function for input port SendFile.

Parameters
portNumThe port number
sourceFileNamePath of file to downlink
destFileNamePath to store downlinked file at
offsetAmount of data in bytes to downlink from file. 0 to read until end of file
lengthAmount of data in bytes to downlink from file. 0 to read until end of file

Definition at line 1047 of file FileDownlinkComponentAc.cpp.

◆ SendFile_preMsgHook()

void Svc::FileDownlinkComponentBase::SendFile_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command SendFile.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1478 of file FileDownlinkComponentAc.cpp.

◆ SendPartial_cmdHandler()

virtual void Svc::FileDownlinkComponentBase::SendPartial_cmdHandler ( FwOpcodeType  opCode,
U32  cmdSeq,
const Fw::CmdStringArg sourceFileName,
const Fw::CmdStringArg destFileName,
U32  startOffset,
U32  length 
)
protectedpure virtual

Handler for command SendPartial

Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
sourceFileNameThe name of the on-board file to send
destFileNameThe name of the destination file on the ground
startOffsetStarting offset of the source file
lengthNumber of bytes to send from starting offset. Length of 0 implies until the end of the file

◆ SendPartial_cmdHandlerBase()

void Svc::FileDownlinkComponentBase::SendPartial_cmdHandlerBase ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)
protected

Base-class handler function for command SendPartial

Read a named file off the disk from a starting position. Divide it into packets and send the packets for transmission to the ground.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number
argsThe command argument buffer

Definition at line 1411 of file FileDownlinkComponentAc.cpp.

◆ SendPartial_preMsgHook()

void Svc::FileDownlinkComponentBase::SendPartial_preMsgHook ( FwOpcodeType  opCode,
U32  cmdSeq 
)
protectedvirtual

Pre-message hook for command SendPartial.

Parameters
opCodeThe opcode
cmdSeqThe command sequence number

Definition at line 1500 of file FileDownlinkComponentAc.cpp.

◆ set_bufferSendOut_OutputPort()

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

Connect port to bufferSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 560 of file FileDownlinkComponentAc.cpp.

◆ set_cmdRegOut_OutputPort()

void Svc::FileDownlinkComponentBase::set_cmdRegOut_OutputPort ( FwIndexType  portNum,
Fw::InputCmdRegPort port 
)

Connect port to cmdRegOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 454 of file FileDownlinkComponentAc.cpp.

◆ set_cmdResponseOut_OutputPort()

void Svc::FileDownlinkComponentBase::set_cmdResponseOut_OutputPort ( FwIndexType  portNum,
Fw::InputCmdResponsePort port 
)

Connect port to cmdResponseOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 468 of file FileDownlinkComponentAc.cpp.

◆ set_eventOut_OutputPort()

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

Connect port to eventOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 482 of file FileDownlinkComponentAc.cpp.

◆ set_FileComplete_OutputPort()

void Svc::FileDownlinkComponentBase::set_FileComplete_OutputPort ( FwIndexType  portNum,
Svc::InputSendFileCompletePort port 
)

Connect port to FileComplete[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 546 of file FileDownlinkComponentAc.cpp.

◆ set_pingOut_OutputPort()

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

Connect port to pingOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 574 of file FileDownlinkComponentAc.cpp.

◆ set_timeCaller_OutputPort()

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

Connect port to timeCaller[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 514 of file FileDownlinkComponentAc.cpp.

◆ set_tlmOut_OutputPort()

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

Connect port to tlmOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 528 of file FileDownlinkComponentAc.cpp.

◆ tlmWrite_FilesSent()

void Svc::FileDownlinkComponentBase::tlmWrite_FilesSent ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel FilesSent

The total number of files sent

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

Definition at line 2375 of file FileDownlinkComponentAc.cpp.

◆ tlmWrite_PacketsSent()

void Svc::FileDownlinkComponentBase::tlmWrite_PacketsSent ( U32  arg,
Fw::Time  _tlmTime = Fw::Time() 
)
protected

Write telemetry channel PacketsSent

The total number of packets sent

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

Definition at line 2408 of file FileDownlinkComponentAc.cpp.

◆ tlmWrite_Warnings()

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

Write telemetry channel Warnings

The total number of warnings

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

Definition at line 2441 of file FileDownlinkComponentAc.cpp.

◆ unLock()

void Svc::FileDownlinkComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 2504 of file FileDownlinkComponentAc.cpp.

Friends And Related Function Documentation

◆ FileDownlinkComponentBaseFriend

friend class FileDownlinkComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 48 of file FileDownlinkComponentAc.hpp.


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