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

#include <Fw/Cmd/CmdPortAc.hpp>

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

Public Types

enum  { SERIALIZED_SIZE }
 
typedef void(* CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 The port callback function type. More...
 

Public Member Functions

 InputCmdPort ()
 Constructor. More...
 
void init ()
 Initialization function. More...
 
void addCallComp (Fw::PassiveComponentBase *callComp, CompFuncPtr funcPtr)
 Register a component. More...
 
void invoke (FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)
 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 Cmd port Port for sending commands

Definition at line 25 of file CmdPortAc.hpp.

Member Typedef Documentation

◆ CompFuncPtr

typedef void(* Fw::InputCmdPort::CompFuncPtr) (Fw::PassiveComponentBase *callComp, FwIndexType portNum, FwOpcodeType opCode, U32 cmdSeq, Fw::CmdArgBuffer &args)

The port callback function type.

Definition at line 50 of file CmdPortAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIALIZED_SIZE 

The size of the serial representations of the port arguments.

Definition at line 35 of file CmdPortAc.hpp.

Constructor & Destructor Documentation

◆ InputCmdPort()

Fw::InputCmdPort::InputCmdPort ( )

Constructor.

Definition at line 47 of file CmdPortAc.cpp.

Member Function Documentation

◆ addCallComp()

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

Register a component.

Parameters
callCompThe containing component
funcPtrThe port callback function

Definition at line 61 of file CmdPortAc.cpp.

◆ init()

void Fw::InputCmdPort::init ( )
virtual

Initialization function.

Reimplemented from Fw::InputPortBase.

Definition at line 55 of file CmdPortAc.cpp.

◆ invoke()

void Fw::InputCmdPort::invoke ( FwOpcodeType  opCode,
U32  cmdSeq,
Fw::CmdArgBuffer args 
)

Invoke a port interface.

Parameters
opCodeCommand Op Code
cmdSeqCommand Sequence
argsBuffer containing arguments

Definition at line 75 of file CmdPortAc.cpp.


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