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

Auto-generated base for GroundInterface component. More...

#include <Svc/GroundInterface/GroundInterfaceComponentAc.hpp>

Inheritance diagram for Svc::GroundInterfaceComponentBase:
Fw::PassiveComponentBase Fw::ObjBase Svc::GroundInterfaceComponentImpl

Public Member Functions

void init (NATIVE_INT_TYPE instance=0)
 Initialize GroundInterfaceComponentBase object. More...
 
Fw::InputComPortget_downlinkPort_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputBufferSendPortget_fileDownlinkBufferSendIn_InputPort (NATIVE_INT_TYPE portNum)
 
Fw::InputBufferSendPortget_readCallback_InputPort (NATIVE_INT_TYPE portNum)
 
Svc::InputSchedPortget_schedIn_InputPort (NATIVE_INT_TYPE portNum)
 
void set_Log_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputLogPort *port)
 Connect port to Log[portNum]. More...
 
void set_Time_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputTimePort *port)
 Connect port to Time[portNum]. More...
 
void set_fileDownlinkBufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to fileDownlinkBufferSendOut[portNum]. More...
 
void set_fileUplinkBufferGet_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferGetPort *port)
 Connect port to fileUplinkBufferGet[portNum]. More...
 
void set_fileUplinkBufferSendOut_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to fileUplinkBufferSendOut[portNum]. More...
 
void set_readPoll_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to readPoll[portNum]. More...
 
void set_uplinkPort_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputComPort *port)
 Connect port to uplinkPort[portNum]. More...
 
void set_write_OutputPort (NATIVE_INT_TYPE portNum, Fw::InputBufferSendPort *port)
 Connect port to write[portNum]. More...
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base. More...
 
U32 getIdBase () const
 

Protected Types

enum  { NUM_DOWNLINKPORT_INPUT_PORTS = 1 , NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS = 1 , NUM_READCALLBACK_INPUT_PORTS = 1 , NUM_SCHEDIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_LOG_OUTPUT_PORTS = 1 , NUM_LOGTEXT_OUTPUT_PORTS = 1 , NUM_TIME_OUTPUT_PORTS = 1 }
 Enumerations for numbers of special output ports. More...
 
enum  {
  NUM_FILEDOWNLINKBUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_FILEUPLINKBUFFERGET_OUTPUT_PORTS = 1 , NUM_FILEUPLINKBUFFERSENDOUT_OUTPUT_PORTS = 1 , NUM_READPOLL_OUTPUT_PORTS = 1 ,
  NUM_UPLINKPORT_OUTPUT_PORTS = 1 , NUM_WRITE_OUTPUT_PORTS = 1
}
 Enumerations for numbers of typed output ports. More...
 
enum  { EVENTID_GROUNDINTERFACEERROR = 0x0 }
 Event IDs. More...
 

Protected Member Functions

 GroundInterfaceComponentBase (const char *compName="")
 Construct GroundInterfaceComponentBase object. More...
 
virtual ~GroundInterfaceComponentBase ()
 Destroy GroundInterfaceComponentBase object. More...
 
NATIVE_INT_TYPE getNum_downlinkPort_InputPorts () const
 
NATIVE_INT_TYPE getNum_fileDownlinkBufferSendIn_InputPorts () const
 
NATIVE_INT_TYPE getNum_readCallback_InputPorts () const
 
NATIVE_INT_TYPE getNum_schedIn_InputPorts () const
 
NATIVE_INT_TYPE getNum_Log_OutputPorts () const
 
NATIVE_INT_TYPE getNum_Time_OutputPorts () const
 
NATIVE_INT_TYPE getNum_fileDownlinkBufferSendOut_OutputPorts () const
 
NATIVE_INT_TYPE getNum_fileUplinkBufferGet_OutputPorts () const
 
NATIVE_INT_TYPE getNum_fileUplinkBufferSendOut_OutputPorts () const
 
NATIVE_INT_TYPE getNum_readPoll_OutputPorts () const
 
NATIVE_INT_TYPE getNum_uplinkPort_OutputPorts () const
 
NATIVE_INT_TYPE getNum_write_OutputPorts () const
 
bool isConnected_Log_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_Time_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_fileDownlinkBufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_fileUplinkBufferGet_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_fileUplinkBufferSendOut_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_readPoll_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_uplinkPort_OutputPort (NATIVE_INT_TYPE portNum)
 
bool isConnected_write_OutputPort (NATIVE_INT_TYPE portNum)
 
virtual void downlinkPort_handler (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)=0
 Handler for input port downlinkPort. More...
 
virtual void fileDownlinkBufferSendIn_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port fileDownlinkBufferSendIn. More...
 
virtual void readCallback_handler (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)=0
 Handler for input port readCallback. More...
 
virtual void schedIn_handler (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)=0
 Handler for input port schedIn. More...
 
void downlinkPort_handlerBase (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
 Handler base-class function for input port downlinkPort. More...
 
void fileDownlinkBufferSendIn_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port fileDownlinkBufferSendIn. More...
 
void readCallback_handlerBase (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port readCallback. More...
 
void schedIn_handlerBase (NATIVE_INT_TYPE portNum, NATIVE_UINT_TYPE context)
 Handler base-class function for input port schedIn. More...
 
void fileDownlinkBufferSendOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port fileDownlinkBufferSendOut. More...
 
Fw::Buffer fileUplinkBufferGet_out (NATIVE_INT_TYPE portNum, U32 size)
 Invoke output port fileUplinkBufferGet. More...
 
void fileUplinkBufferSendOut_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port fileUplinkBufferSendOut. More...
 
void readPoll_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port readPoll. More...
 
void uplinkPort_out (NATIVE_INT_TYPE portNum, Fw::ComBuffer &data, U32 context)
 Invoke output port uplinkPort. More...
 
void write_out (NATIVE_INT_TYPE portNum, Fw::Buffer &fwBuffer)
 Invoke output port write. More...
 
void log_WARNING_HI_GroundInterfaceError ()
 
Fw::Time getTime ()
 
virtual void lock ()
 Lock the guarded mutex. More...
 
virtual void unLock ()
 Unlock the guarded mutex. 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...
 

Friends

class GroundInterfaceComponentBaseFriend
 Friend class for white-box testing. More...
 

Detailed Description

Auto-generated base for GroundInterface component.

A component representing the FSW ground interface

Definition at line 32 of file GroundInterfaceComponentAc.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed input ports.

Enumerator
NUM_DOWNLINKPORT_INPUT_PORTS 
NUM_FILEDOWNLINKBUFFERSENDIN_INPUT_PORTS 
NUM_READCALLBACK_INPUT_PORTS 
NUM_SCHEDIN_INPUT_PORTS 

Definition at line 50 of file GroundInterfaceComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of special output ports.

Enumerator
NUM_LOG_OUTPUT_PORTS 
NUM_LOGTEXT_OUTPUT_PORTS 
NUM_TIME_OUTPUT_PORTS 

Definition at line 58 of file GroundInterfaceComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Enumerations for numbers of typed output ports.

Enumerator
NUM_FILEDOWNLINKBUFFERSENDOUT_OUTPUT_PORTS 
NUM_FILEUPLINKBUFFERGET_OUTPUT_PORTS 
NUM_FILEUPLINKBUFFERSENDOUT_OUTPUT_PORTS 
NUM_READPOLL_OUTPUT_PORTS 
NUM_UPLINKPORT_OUTPUT_PORTS 
NUM_WRITE_OUTPUT_PORTS 

Definition at line 65 of file GroundInterfaceComponentAc.hpp.

◆ anonymous enum

anonymous enum
protected

Event IDs.

Enumerator
EVENTID_GROUNDINTERFACEERROR 

An error in the ground interface, here to make the UTs happy.

Definition at line 75 of file GroundInterfaceComponentAc.hpp.

Constructor & Destructor Documentation

◆ GroundInterfaceComponentBase()

Svc::GroundInterfaceComponentBase::GroundInterfaceComponentBase ( const char *  compName = "")
protected

Construct GroundInterfaceComponentBase object.

Parameters
compNameThe component name

Definition at line 723 of file GroundInterfaceComponentAc.cpp.

◆ ~GroundInterfaceComponentBase()

Svc::GroundInterfaceComponentBase::~GroundInterfaceComponentBase ( )
protectedvirtual

Destroy GroundInterfaceComponentBase object.

Definition at line 730 of file GroundInterfaceComponentAc.cpp.

Member Function Documentation

◆ downlinkPort_handler()

virtual void Svc::GroundInterfaceComponentBase::downlinkPort_handler ( NATIVE_INT_TYPE  portNum,
Fw::ComBuffer data,
U32  context 
)
protectedpure virtual

Handler for input port downlinkPort.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

◆ downlinkPort_handlerBase()

void Svc::GroundInterfaceComponentBase::downlinkPort_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::ComBuffer data,
U32  context 
)
protected

Handler base-class function for input port downlinkPort.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 947 of file GroundInterfaceComponentAc.cpp.

◆ fileDownlinkBufferSendIn_handler()

virtual void Svc::GroundInterfaceComponentBase::fileDownlinkBufferSendIn_handler ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port fileDownlinkBufferSendIn.

Parameters
portNumThe port number
fwBufferThe buffer

◆ fileDownlinkBufferSendIn_handlerBase()

void Svc::GroundInterfaceComponentBase::fileDownlinkBufferSendIn_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port fileDownlinkBufferSendIn.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 974 of file GroundInterfaceComponentAc.cpp.

◆ fileDownlinkBufferSendOut_out()

void Svc::GroundInterfaceComponentBase::fileDownlinkBufferSendOut_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port fileDownlinkBufferSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1053 of file GroundInterfaceComponentAc.cpp.

◆ fileUplinkBufferGet_out()

Fw::Buffer Svc::GroundInterfaceComponentBase::fileUplinkBufferGet_out ( NATIVE_INT_TYPE  portNum,
U32  size 
)
protected

Invoke output port fileUplinkBufferGet.

Parameters
portNumThe port number
sizeThe requested size

Definition at line 1068 of file GroundInterfaceComponentAc.cpp.

◆ fileUplinkBufferSendOut_out()

void Svc::GroundInterfaceComponentBase::fileUplinkBufferSendOut_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port fileUplinkBufferSendOut.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1083 of file GroundInterfaceComponentAc.cpp.

◆ get_downlinkPort_InputPort()

Fw::InputComPort * Svc::GroundInterfaceComponentBase::get_downlinkPort_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
downlinkPort[portNum]
Parameters
portNumThe port number

Definition at line 405 of file GroundInterfaceComponentAc.cpp.

◆ get_fileDownlinkBufferSendIn_InputPort()

Fw::InputBufferSendPort * Svc::GroundInterfaceComponentBase::get_fileDownlinkBufferSendIn_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
fileDownlinkBufferSendIn[portNum]
Parameters
portNumThe port number

Definition at line 416 of file GroundInterfaceComponentAc.cpp.

◆ get_readCallback_InputPort()

Fw::InputBufferSendPort * Svc::GroundInterfaceComponentBase::get_readCallback_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
readCallback[portNum]
Parameters
portNumThe port number

Definition at line 427 of file GroundInterfaceComponentAc.cpp.

◆ get_schedIn_InputPort()

Svc::InputSchedPort * Svc::GroundInterfaceComponentBase::get_schedIn_InputPort ( NATIVE_INT_TYPE  portNum)

Get typed input port at index

Returns
schedIn[portNum]
Parameters
portNumThe port number

Definition at line 438 of file GroundInterfaceComponentAc.cpp.

◆ getNum_downlinkPort_InputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_downlinkPort_InputPorts ( ) const
protected

Get the number of downlinkPort input ports

Returns
The number of downlinkPort input ports

Definition at line 740 of file GroundInterfaceComponentAc.cpp.

◆ getNum_fileDownlinkBufferSendIn_InputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_fileDownlinkBufferSendIn_InputPorts ( ) const
protected

Get the number of fileDownlinkBufferSendIn input ports

Returns
The number of fileDownlinkBufferSendIn input ports

Definition at line 746 of file GroundInterfaceComponentAc.cpp.

◆ getNum_fileDownlinkBufferSendOut_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_fileDownlinkBufferSendOut_OutputPorts ( ) const
protected

Get the number of fileDownlinkBufferSendOut output ports

Returns
The number of fileDownlinkBufferSendOut output ports

Definition at line 794 of file GroundInterfaceComponentAc.cpp.

◆ getNum_fileUplinkBufferGet_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_fileUplinkBufferGet_OutputPorts ( ) const
protected

Get the number of fileUplinkBufferGet output ports

Returns
The number of fileUplinkBufferGet output ports

Definition at line 800 of file GroundInterfaceComponentAc.cpp.

◆ getNum_fileUplinkBufferSendOut_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_fileUplinkBufferSendOut_OutputPorts ( ) const
protected

Get the number of fileUplinkBufferSendOut output ports

Returns
The number of fileUplinkBufferSendOut output ports

Definition at line 806 of file GroundInterfaceComponentAc.cpp.

◆ getNum_Log_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_Log_OutputPorts ( ) const
protected

Get the number of Log output ports

Returns
The number of Log output ports

Definition at line 768 of file GroundInterfaceComponentAc.cpp.

◆ getNum_readCallback_InputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_readCallback_InputPorts ( ) const
protected

Get the number of readCallback input ports

Returns
The number of readCallback input ports

Definition at line 752 of file GroundInterfaceComponentAc.cpp.

◆ getNum_readPoll_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_readPoll_OutputPorts ( ) const
protected

Get the number of readPoll output ports

Returns
The number of readPoll output ports

Definition at line 812 of file GroundInterfaceComponentAc.cpp.

◆ getNum_schedIn_InputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_schedIn_InputPorts ( ) const
protected

Get the number of schedIn input ports

Returns
The number of schedIn input ports

Definition at line 758 of file GroundInterfaceComponentAc.cpp.

◆ getNum_Time_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_Time_OutputPorts ( ) const
protected

Get the number of Time output ports

Returns
The number of Time output ports

Definition at line 784 of file GroundInterfaceComponentAc.cpp.

◆ getNum_uplinkPort_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_uplinkPort_OutputPorts ( ) const
protected

Get the number of uplinkPort output ports

Returns
The number of uplinkPort output ports

Definition at line 818 of file GroundInterfaceComponentAc.cpp.

◆ getNum_write_OutputPorts()

NATIVE_INT_TYPE Svc::GroundInterfaceComponentBase::getNum_write_OutputPorts ( ) const
protected

Get the number of write output ports

Returns
The number of write output ports

Definition at line 824 of file GroundInterfaceComponentAc.cpp.

◆ getTime()

Fw::Time Svc::GroundInterfaceComponentBase::getTime ( )
protected

Get the time

\return The current time

Definition at line 1224 of file GroundInterfaceComponentAc.cpp.

◆ init()

void Svc::GroundInterfaceComponentBase::init ( NATIVE_INT_TYPE  instance = 0)

Initialize GroundInterfaceComponentBase object.

Parameters
instanceThe instance number

Definition at line 21 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_fileDownlinkBufferSendOut_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_fileDownlinkBufferSendOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port fileDownlinkBufferSendOut is connected

Returns
Whether port fileDownlinkBufferSendOut is connected
Parameters
portNumThe port number

Definition at line 875 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_fileUplinkBufferGet_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_fileUplinkBufferGet_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port fileUplinkBufferGet is connected

Returns
Whether port fileUplinkBufferGet is connected
Parameters
portNumThe port number

Definition at line 886 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_fileUplinkBufferSendOut_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_fileUplinkBufferSendOut_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port fileUplinkBufferSendOut is connected

Returns
Whether port fileUplinkBufferSendOut is connected
Parameters
portNumThe port number

Definition at line 897 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_Log_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_Log_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port Log is connected

Returns
Whether port Log is connected
Parameters
portNumThe port number

Definition at line 834 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_readPoll_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_readPoll_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port readPoll is connected

Returns
Whether port readPoll is connected
Parameters
portNumThe port number

Definition at line 908 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_Time_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_Time_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port Time is connected

Returns
Whether port Time is connected
Parameters
portNumThe port number

Definition at line 860 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_uplinkPort_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_uplinkPort_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port uplinkPort is connected

Returns
Whether port uplinkPort is connected
Parameters
portNumThe port number

Definition at line 919 of file GroundInterfaceComponentAc.cpp.

◆ isConnected_write_OutputPort()

bool Svc::GroundInterfaceComponentBase::isConnected_write_OutputPort ( NATIVE_INT_TYPE  portNum)
protected

Check whether port write is connected

Returns
Whether port write is connected
Parameters
portNumThe port number

Definition at line 930 of file GroundInterfaceComponentAc.cpp.

◆ lock()

void Svc::GroundInterfaceComponentBase::lock ( )
protectedvirtual

Lock the guarded mutex.

Definition at line 1244 of file GroundInterfaceComponentAc.cpp.

◆ log_WARNING_HI_GroundInterfaceError()

void Svc::GroundInterfaceComponentBase::log_WARNING_HI_GroundInterfaceError ( )
protected

Log event GroundInterfaceError

An error in the ground interface, here to make the UTs happy.

Definition at line 1149 of file GroundInterfaceComponentAc.cpp.

◆ readCallback_handler()

virtual void Svc::GroundInterfaceComponentBase::readCallback_handler ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protectedpure virtual

Handler for input port readCallback.

Parameters
portNumThe port number
fwBufferThe buffer

◆ readCallback_handlerBase()

void Svc::GroundInterfaceComponentBase::readCallback_handlerBase ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Handler base-class function for input port readCallback.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 999 of file GroundInterfaceComponentAc.cpp.

◆ readPoll_out()

void Svc::GroundInterfaceComponentBase::readPoll_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port readPoll.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1098 of file GroundInterfaceComponentAc.cpp.

◆ schedIn_handler()

virtual void Svc::GroundInterfaceComponentBase::schedIn_handler ( NATIVE_INT_TYPE  portNum,
NATIVE_UINT_TYPE  context 
)
protectedpure virtual

Handler for input port schedIn.

Parameters
portNumThe port number
contextThe call order

◆ schedIn_handlerBase()

void Svc::GroundInterfaceComponentBase::schedIn_handlerBase ( NATIVE_INT_TYPE  portNum,
NATIVE_UINT_TYPE  context 
)
protected

Handler base-class function for input port schedIn.

Parameters
portNumThe port number
contextThe call order

Definition at line 1024 of file GroundInterfaceComponentAc.cpp.

◆ set_fileDownlinkBufferSendOut_OutputPort()

void Svc::GroundInterfaceComponentBase::set_fileDownlinkBufferSendOut_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to fileDownlinkBufferSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 503 of file GroundInterfaceComponentAc.cpp.

◆ set_fileUplinkBufferGet_OutputPort()

void Svc::GroundInterfaceComponentBase::set_fileUplinkBufferGet_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferGetPort port 
)

Connect port to fileUplinkBufferGet[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 517 of file GroundInterfaceComponentAc.cpp.

◆ set_fileUplinkBufferSendOut_OutputPort()

void Svc::GroundInterfaceComponentBase::set_fileUplinkBufferSendOut_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to fileUplinkBufferSendOut[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 531 of file GroundInterfaceComponentAc.cpp.

◆ set_Log_OutputPort()

void Svc::GroundInterfaceComponentBase::set_Log_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputLogPort port 
)

Connect port to Log[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 453 of file GroundInterfaceComponentAc.cpp.

◆ set_readPoll_OutputPort()

void Svc::GroundInterfaceComponentBase::set_readPoll_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to readPoll[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 545 of file GroundInterfaceComponentAc.cpp.

◆ set_Time_OutputPort()

void Svc::GroundInterfaceComponentBase::set_Time_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputTimePort port 
)

Connect port to Time[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 485 of file GroundInterfaceComponentAc.cpp.

◆ set_uplinkPort_OutputPort()

void Svc::GroundInterfaceComponentBase::set_uplinkPort_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputComPort port 
)

Connect port to uplinkPort[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 559 of file GroundInterfaceComponentAc.cpp.

◆ set_write_OutputPort()

void Svc::GroundInterfaceComponentBase::set_write_OutputPort ( NATIVE_INT_TYPE  portNum,
Fw::InputBufferSendPort port 
)

Connect port to write[portNum].

Parameters
portNumThe port number
portThe input port

Definition at line 573 of file GroundInterfaceComponentAc.cpp.

◆ unLock()

void Svc::GroundInterfaceComponentBase::unLock ( )
protectedvirtual

Unlock the guarded mutex.

Definition at line 1250 of file GroundInterfaceComponentAc.cpp.

◆ uplinkPort_out()

void Svc::GroundInterfaceComponentBase::uplinkPort_out ( NATIVE_INT_TYPE  portNum,
Fw::ComBuffer data,
U32  context 
)
protected

Invoke output port uplinkPort.

Parameters
portNumThe port number
dataBuffer containing packet data
contextCall context value; meaning chosen by user

Definition at line 1113 of file GroundInterfaceComponentAc.cpp.

◆ write_out()

void Svc::GroundInterfaceComponentBase::write_out ( NATIVE_INT_TYPE  portNum,
Fw::Buffer fwBuffer 
)
protected

Invoke output port write.

Parameters
portNumThe port number
fwBufferThe buffer

Definition at line 1130 of file GroundInterfaceComponentAc.cpp.

Friends And Related Function Documentation

◆ GroundInterfaceComponentBaseFriend

friend class GroundInterfaceComponentBaseFriend
friend

Friend class for white-box testing.

Definition at line 41 of file GroundInterfaceComponentAc.hpp.


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