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

#include <Svc/GroundInterface/GroundInterface.hpp>

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

Public Member Functions

 GroundInterfaceComponentImpl (const char *const compName)
 
void init (const NATIVE_INT_TYPE instance=0)
 
 ~GroundInterfaceComponentImpl ()
 
- Public Member Functions inherited from Svc::GroundInterfaceComponentBase
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
 

Static Public Attributes

static const U32 MAX_DATA_SIZE = 2048
 
static const TOKEN_TYPE START_WORD = static_cast<TOKEN_TYPE>(0xdeadbeef)
 
static const U32 END_WORD = static_cast<U32>(0xcafecafe)
 

Additional Inherited Members

- Protected Types inherited from Svc::GroundInterfaceComponentBase
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 inherited from Svc::GroundInterfaceComponentBase
 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)
 
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...
 

Detailed Description

Definition at line 18 of file GroundInterface.hpp.

Constructor & Destructor Documentation

◆ GroundInterfaceComponentImpl()

Svc::GroundInterfaceComponentImpl::GroundInterfaceComponentImpl ( const char *const  compName)

Construct object GroundInterface

Parameters
compNameThe component name

Definition at line 22 of file GroundInterface.cpp.

◆ ~GroundInterfaceComponentImpl()

Svc::GroundInterfaceComponentImpl::~GroundInterfaceComponentImpl ( )

Destroy object GroundInterface

Definition at line 41 of file GroundInterface.cpp.

Member Function Documentation

◆ init()

void Svc::GroundInterfaceComponentImpl::init ( const NATIVE_INT_TYPE  instance = 0)

Initialize object GroundInterface

Parameters
instanceThe instance number

Definition at line 33 of file GroundInterface.cpp.

Member Data Documentation

◆ END_WORD

const U32 Svc::GroundInterfaceComponentImpl::END_WORD = static_cast<U32>(0xcafecafe)
static

Definition at line 24 of file GroundInterface.hpp.

◆ MAX_DATA_SIZE

const U32 Svc::GroundInterfaceComponentImpl::MAX_DATA_SIZE = 2048
static

Definition at line 22 of file GroundInterface.hpp.

◆ START_WORD

const TOKEN_TYPE Svc::GroundInterfaceComponentImpl::START_WORD = static_cast<TOKEN_TYPE>(0xdeadbeef)
static

Definition at line 23 of file GroundInterface.hpp.


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