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

#include <Svc/FileDownlinkPorts/SendFileRequestPortAc.hpp>

Inheritance diagram for Svc::InputSendFileRequestPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE }
 
typedef Svc::SendFileResponse(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)
 The port callback function type. More...
 

Public Member Functions

 InputSendFileRequestPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
Svc::SendFileResponse invoke (const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (NATIVE_INT_TYPE portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected ()
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
- Protected Member Functions inherited from Fw::PortBase
 PortBase ()
 
virtual ~PortBase ()
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor. More...
 
virtual ~ObjBase ()
 Destructor. More...
 
void init ()
 Object initializer. More...
 
- Protected Attributes inherited from Fw::InputPortBase
PassiveComponentBasem_comp
 
NATIVE_INT_TYPE m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input SendFileRequest port Request that FileDownlink downlink a file

Definition at line 24 of file SendFileRequestPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef Svc::SendFileResponse(* Svc::InputSendFileRequestPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, const Fw::StringBase &sourceFileName, const Fw::StringBase &destFileName, U32 offset, U32 length)

The port callback function type.

Definition at line 50 of file SendFileRequestPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 34 of file SendFileRequestPortAc.hpp.

Constructor & Destructor Documentation

◆ InputSendFileRequestPort()

Svc::InputSendFileRequestPort::InputSendFileRequestPort ( )

Constructor.

Definition at line 17 of file SendFileRequestPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Svc::InputSendFileRequestPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 31 of file SendFileRequestPortAc.cpp.

◆ init()

void Svc::InputSendFileRequestPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 25 of file SendFileRequestPortAc.cpp.

◆ invoke()

Svc::SendFileResponse Svc::InputSendFileRequestPort::invoke ( const Fw::StringBase sourceFileName,
const Fw::StringBase destFileName,
U32  offset,
U32  length 
)

Invoke a port interface.

Parameters
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 45 of file SendFileRequestPortAc.cpp.


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