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

#include <Drv/BlockDriver/BlockDriverImpl.hpp>

Inheritance diagram for Drv::BlockDriverImpl:
Drv::BlockDriverComponentBase Fw::ActiveComponentBase Fw::QueuedComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Member Functions

 BlockDriverImpl (const char *compName)
 
void init (NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instanceId=0)
 
 ~BlockDriverImpl ()
 
void callIsr ()
 
- Public Member Functions inherited from Drv::BlockDriverComponentBase
void init (FwQueueSizeType queueDepth, FwEnumStoreType instance=0)
 Initialize BlockDriverComponentBase object. More...
 
Drv::InputDataBufferPortget_BufferIn_InputPort (FwIndexType portNum)
 
Svc::InputPingPortget_PingIn_InputPort (FwIndexType portNum)
 
Svc::InputSchedPortget_Sched_InputPort (FwIndexType portNum)
 
void set_Time_OutputPort (FwIndexType portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_Tlm_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to Tlm[portNum]. More...
 
void set_BufferOut_OutputPort (FwIndexType portNum, Drv::InputDataBufferPort *port)
 Connect port to BufferOut[portNum]. More...
 
void set_CycleOut_OutputPort (FwIndexType portNum, Svc::InputCyclePort *port)
 Connect port to CycleOut[portNum]. More...
 
void set_PingOut_OutputPort (FwIndexType portNum, Svc::InputPingPort *port)
 Connect port to PingOut[portNum]. 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
 

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 Types inherited from Drv::BlockDriverComponentBase
enum  { NUM_BUFFERIN_INPUT_PORTS = 1 , NUM_PINGIN_INPUT_PORTS = 1 , NUM_SCHED_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_TIME_OUTPUT_PORTS = 1 , NUM_TLM_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  { NUM_BUFFEROUT_OUTPUT_PORTS = 1 , NUM_CYCLEOUT_OUTPUT_PORTS = 1 , NUM_PINGOUT_OUTPUT_PORTS = 1 }
 Enumerations for numbers of typed output ports. More...
 
enum  { CHANNELID_BD_CYCLES = 0x0 }
 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 inherited from Drv::BlockDriverComponentBase
 BlockDriverComponentBase (const char *compName="")
 Construct BlockDriverComponentBase object. More...
 
virtual ~BlockDriverComponentBase ()
 Destroy BlockDriverComponentBase object. More...
 
FwIndexType getNum_BufferIn_InputPorts () const
 
FwIndexType getNum_PingIn_InputPorts () const
 
FwIndexType getNum_Sched_InputPorts () const
 
FwIndexType getNum_Time_OutputPorts () const
 
FwIndexType getNum_Tlm_OutputPorts () const
 
FwIndexType getNum_BufferOut_OutputPorts () const
 
FwIndexType getNum_CycleOut_OutputPorts () const
 
FwIndexType getNum_PingOut_OutputPorts () const
 
bool isConnected_Time_OutputPort (FwIndexType portNum)
 
bool isConnected_Tlm_OutputPort (FwIndexType portNum)
 
bool isConnected_BufferOut_OutputPort (FwIndexType portNum)
 
bool isConnected_CycleOut_OutputPort (FwIndexType portNum)
 
bool isConnected_PingOut_OutputPort (FwIndexType portNum)
 
void BufferIn_handlerBase (FwIndexType portNum, Drv::DataBuffer &buff)
 Handler base-class function for input port BufferIn. More...
 
void PingIn_handlerBase (FwIndexType portNum, U32 key)
 Handler base-class function for input port PingIn. More...
 
void Sched_handlerBase (FwIndexType portNum, U32 context)
 Handler base-class function for input port Sched. More...
 
virtual void BufferIn_preMsgHook (FwIndexType portNum, Drv::DataBuffer &buff)
 Pre-message hook for async input port BufferIn. More...
 
virtual void PingIn_preMsgHook (FwIndexType portNum, U32 key)
 Pre-message hook for async input port PingIn. More...
 
virtual void Sched_preMsgHook (FwIndexType portNum, U32 context)
 Pre-message hook for async input port Sched. More...
 
void BufferOut_out (FwIndexType portNum, Drv::DataBuffer &buff)
 Invoke output port BufferOut. More...
 
void CycleOut_out (FwIndexType portNum, Svc::TimerVal &cycleStart)
 Invoke output port CycleOut. More...
 
void PingOut_out (FwIndexType portNum, U32 key)
 Invoke output port PingOut. More...
 
void InterruptReport_internalInterfaceInvoke (U32 interrupt)
 Internal interface base-class function for InterruptReport. More...
 
void tlmWrite_BD_Cycles (U32 arg, Fw::Time _tlmTime=Fw::Time())
 
Fw::Time getTime ()
 
- 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...
 
- 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

Definition at line 8 of file BlockDriverImpl.hpp.

Constructor & Destructor Documentation

◆ BlockDriverImpl()

Drv::BlockDriverImpl::BlockDriverImpl ( const char *  compName)

Definition at line 7 of file BlockDriverImpl.cpp.

◆ ~BlockDriverImpl()

Drv::BlockDriverImpl::~BlockDriverImpl ( )

Definition at line 17 of file BlockDriverImpl.cpp.

Member Function Documentation

◆ callIsr()

void Drv::BlockDriverImpl::callIsr ( )

Definition at line 40 of file BlockDriverImpl.cpp.

◆ init()

void Drv::BlockDriverImpl::init ( NATIVE_INT_TYPE  queueDepth,
NATIVE_INT_TYPE  instanceId = 0 
)

Definition at line 13 of file BlockDriverImpl.cpp.


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