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

#include <Fw/Ports/Ready/ReadyPortAc.hpp>

Inheritance diagram for Fw::InputReadyPort:
Fw::InputPortBase Fw::PortBase Fw::ObjBase

Public Types

enum  { SERIALIZED_SIZE = 0 }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum)
 The port callback function type. More...
 

Public Member Functions

 InputReadyPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke ()
 Invoke a port interface. More...
 
- Public Member Functions inherited from Fw::InputPortBase
void setPortNum (FwIndexType portNum)
 
- Public Member Functions inherited from Fw::PortBase
bool isConnected () const
 

Additional Inherited Members

- Protected Member Functions inherited from Fw::InputPortBase
 InputPortBase ()
 
virtual ~InputPortBase ()
 
void init () override
 
- 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
 
FwIndexType m_portNum
 
- Protected Attributes inherited from Fw::PortBase
Fw::ObjBasem_connObj
 

Detailed Description

Input Ready port As an input: Request that a component start operating or indicate that the prerequisites for the component are satisfied. As an output: Indicate that a component is now operating normally and is ready to service requests.

Each Ready port shall be invoked once.

  • Invoking a Ready port more than once is a coding defect worthy of an assertion.
  • Failing to invoke a Ready port is a coding defect that may result in a component remaining inoperative or not becoming fully operative.
  • It may be a coding defect worthy of an assertion, depending on the specification for each component, to attempt to operate a component that is not ready: that is, a component that has not received all Ready inputs or has not yet invoked all Ready outputs.

Definition at line 37 of file ReadyPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputReadyPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum)

The port callback function type.

Definition at line 59 of file ReadyPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 47 of file ReadyPortAc.hpp.

Constructor & Destructor Documentation

◆ InputReadyPort()

Fw::InputReadyPort::InputReadyPort ( )

Constructor.

Definition at line 44 of file ReadyPortAc.cpp.

Member Function Documentation

◆ addCallComp()

void Fw::InputReadyPort::addCallComp ( Fw::PassiveComponentBase callComp,
CompFuncPtr  funcPtr 
)

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 58 of file ReadyPortAc.cpp.

◆ init()

void Fw::InputReadyPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::PortBase.

Definition at line 52 of file ReadyPortAc.cpp.

◆ invoke()

void Fw::InputReadyPort::invoke ( )

Invoke a port interface.

Definition at line 72 of file ReadyPortAc.cpp.


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