F´ Flight Software - C/C++ Documentation  NASA-v2.0.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Svc::FileDownlink Class Reference

#include <Svc/FileDownlink/FileDownlink.hpp>

Inheritance diagram for Svc::FileDownlink:

Public Member Functions

 FileDownlink (const char *const compName)
 
void init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)
 
void configure (U32 timeout, U32 cooldown, U32 cycleTime, U32 fileQueueDepth)
 
void start (NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1)
 
 ~FileDownlink (void)
 

Detailed Description

Definition at line 25 of file FileDownlink.hpp.

Constructor & Destructor Documentation

◆ FileDownlink()

Svc::FileDownlink::FileDownlink ( const char *const  compName)

Construct object FileDownlink

Parameters
compNameThe component name

Definition at line 25 of file FileDownlink.cpp.

◆ ~FileDownlink()

Svc::FileDownlink::~FileDownlink ( void  )

Destroy object FileDownlink

Definition at line 88 of file FileDownlink.cpp.

Member Function Documentation

◆ configure()

void Svc::FileDownlink::configure ( U32  timeout,
U32  cooldown,
U32  cycleTime,
U32  fileQueueDepth 
)

Configure FileDownlink component

Parameters
timeoutTimeout threshold (milliseconds) while in WAIT state
cooldownCooldown (in ms) between finishing a downlink and starting the next file.
cycleTimeRate at which we are running
fileQueueDepthMax number of items in file downlink queue

Definition at line 55 of file FileDownlink.cpp.

◆ init()

void Svc::FileDownlink::init ( const NATIVE_INT_TYPE  queueDepth,
const NATIVE_INT_TYPE  instance 
)

Initialize object FileDownlink

Parameters
queueDepthThe queue depth
instanceThe instance number

Definition at line 46 of file FileDownlink.cpp.

◆ start()

void Svc::FileDownlink::start ( NATIVE_INT_TYPE  identifier,
NATIVE_INT_TYPE  priority,
NATIVE_INT_TYPE  stackSize,
NATIVE_INT_TYPE  cpuAffinity = -1 
)

Start FileDownlink component The component must be configured with configure() before starting.

Definition at line 76 of file FileDownlink.cpp.


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