F´ Flight Software - C/C++ Documentation NASA-v1.6.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:
Svc::FileDownlinkComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

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 preamble ()
 
 ~FileDownlink ()
 
- Public Member Functions inherited from Fw::ActiveComponentBase
void start (NATIVE_UINT_TYPE priority=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE stackSize=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE cpuAffinity=Os::Task::TASK_DEFAULT, NATIVE_UINT_TYPE identifier=Os::Task::TASK_DEFAULT)
 called by instantiator when task is to be started
 
 DEPRECATED (void start(NATIVE_INT_TYPE identifier, NATIVE_INT_TYPE priority, NATIVE_INT_TYPE stackSize, NATIVE_INT_TYPE cpuAffinity=-1), "Please switch to start(NATIVE_UINT_TYPE priority, NATIVE_UINT_TYPE stackSize, NATIVE_UINT_TYPE cpuAffinity, NATIVE_UINT_TYPE identifier)")
 called by instantiator when task is to be started
 
void exit ()
 exit task in active component
 
Os::Task::TaskStatus join (void **value_ptr)
 provide return value of thread if value_ptr is not NULL
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

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 }
 
 Enumerations for numbers of special input ports. More...
 Enumerations for numbers of typed input ports. More...
 Enumerations for numbers of special output ports. More...
 Enumerations for numbers of typed output ports. More...
 Command opcodes. More...
 Event IDs. More...
 Channel IDs. More...
- 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 loop ()
 The function that will loop 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::QueueStatus createQueue (NATIVE_INT_TYPE depth, NATIVE_INT_TYPE 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.
 
- 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

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 ( )

Destroy object FileDownlink

Definition at line 82 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.

◆ preamble()

void Svc::FileDownlink::preamble ( )
virtual

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

Reimplemented from Fw::ActiveComponentBase.

Definition at line 76 of file FileDownlink.cpp.


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