F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Svc::GenericHubComponentImpl Class Reference

#include <Svc/GenericHub/GenericHubComponentImpl.hpp>

Inheritance diagram for Svc::GenericHubComponentImpl:
Svc::GenericHubComponentBase Fw::PassiveComponentBase Fw::ObjBase

Public Types

enum  HubType {
  HUB_TYPE_PORT , HUB_TYPE_BUFFER , HUB_TYPE_EVENT , HUB_TYPE_CHANNEL ,
  HUB_TYPE_MAX
}
 

Public Member Functions

 GenericHubComponentImpl (const char *const compName)
 
 ~GenericHubComponentImpl ()
 
- Public Member Functions inherited from Svc::GenericHubComponentBase
void init (FwEnumStoreType instance=0)
 Initialize GenericHubComponentBase object.
 
Fw::InputLogPortget_LogRecv_InputPort (FwIndexType portNum)
 
Fw::InputTlmPortget_TlmRecv_InputPort (FwIndexType portNum)
 
Fw::InputBufferSendPortget_buffersIn_InputPort (FwIndexType portNum)
 
Fw::InputBufferSendPortget_dataIn_InputPort (FwIndexType portNum)
 
Fw::InputSerializePort * get_portIn_InputPort (FwIndexType portNum)
 
void set_LogSend_OutputPort (FwIndexType portNum, Fw::InputLogPort *port)
 Connect port to LogSend[portNum].
 
void set_TlmSend_OutputPort (FwIndexType portNum, Fw::InputTlmPort *port)
 Connect port to TlmSend[portNum].
 
void set_bufferDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to bufferDeallocate[portNum].
 
void set_buffersOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to buffersOut[portNum].
 
void set_dataInDeallocate_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to dataInDeallocate[portNum].
 
void set_dataOut_OutputPort (FwIndexType portNum, Fw::InputBufferSendPort *port)
 Connect port to dataOut[portNum].
 
void set_dataOutAllocate_OutputPort (FwIndexType portNum, Fw::InputBufferGetPort *port)
 Connect port to dataOutAllocate[portNum].
 
- Public Member Functions inherited from Fw::PassiveComponentBase
void setIdBase (const U32)
 Set the ID base.
 
U32 getIdBase () const
 

Static Public Attributes

static const U32 GENERIC_HUB_DATA_SIZE = 1024
 

Additional Inherited Members

- Protected Types inherited from Svc::GenericHubComponentBase
enum  { NUM_LOGRECV_INPUT_PORTS = 1 , NUM_TLMRECV_INPUT_PORTS = 1 , NUM_BUFFERSIN_INPUT_PORTS = 10 , NUM_DATAIN_INPUT_PORTS = 1 }
 Enumerations for numbers of typed input ports. More...
 
enum  { NUM_PORTIN_INPUT_PORTS = 10 }
 Enumerations for numbers of serial input ports. More...
 
enum  {
  NUM_LOGSEND_OUTPUT_PORTS = 1 , NUM_TLMSEND_OUTPUT_PORTS = 1 , NUM_BUFFERDEALLOCATE_OUTPUT_PORTS = 1 , NUM_BUFFERSOUT_OUTPUT_PORTS = 10 ,
  NUM_DATAINDEALLOCATE_OUTPUT_PORTS = 1 , NUM_DATAOUT_OUTPUT_PORTS = 1 , NUM_DATAOUTALLOCATE_OUTPUT_PORTS = 1
}
 Enumerations for numbers of typed output ports. More...
 
enum  { NUM_PORTOUT_OUTPUT_PORTS = 10 }
 Enumerations for numbers of serial output ports. More...
 
- Protected Member Functions inherited from Svc::GenericHubComponentBase
 GenericHubComponentBase (const char *compName="")
 Construct GenericHubComponentBase object.
 
virtual ~GenericHubComponentBase ()
 Destroy GenericHubComponentBase object.
 
FwIndexType getNum_LogRecv_InputPorts () const
 
FwIndexType getNum_TlmRecv_InputPorts () const
 
FwIndexType getNum_buffersIn_InputPorts () const
 
FwIndexType getNum_dataIn_InputPorts () const
 
FwIndexType getNum_portIn_InputPorts () const
 
FwIndexType getNum_LogSend_OutputPorts () const
 
FwIndexType getNum_TlmSend_OutputPorts () const
 
FwIndexType getNum_bufferDeallocate_OutputPorts () const
 
FwIndexType getNum_buffersOut_OutputPorts () const
 
FwIndexType getNum_dataInDeallocate_OutputPorts () const
 
FwIndexType getNum_dataOut_OutputPorts () const
 
FwIndexType getNum_dataOutAllocate_OutputPorts () const
 
FwIndexType getNum_portOut_OutputPorts () const
 
bool isConnected_LogSend_OutputPort (FwIndexType portNum)
 
bool isConnected_TlmSend_OutputPort (FwIndexType portNum)
 
bool isConnected_bufferDeallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_buffersOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataInDeallocate_OutputPort (FwIndexType portNum)
 
bool isConnected_dataOut_OutputPort (FwIndexType portNum)
 
bool isConnected_dataOutAllocate_OutputPort (FwIndexType portNum)
 
bool isConnected_portOut_OutputPort (FwIndexType portNum)
 
void LogRecv_handlerBase (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
 Handler base-class function for input port LogRecv.
 
void TlmRecv_handlerBase (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 Handler base-class function for input port TlmRecv.
 
void buffersIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port buffersIn.
 
void dataIn_handlerBase (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Handler base-class function for input port dataIn.
 
void portIn_handlerBase (FwIndexType portNum, Fw::SerializeBufferBase &buffer)
 Handler base-class function for input port portIn.
 
void LogSend_out (FwIndexType portNum, FwEventIdType id, Fw::Time &timeTag, const Fw::LogSeverity &severity, Fw::LogBuffer &args)
 Invoke output port LogSend.
 
void TlmSend_out (FwIndexType portNum, FwChanIdType id, Fw::Time &timeTag, Fw::TlmBuffer &val)
 Invoke output port TlmSend.
 
void bufferDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port bufferDeallocate.
 
void buffersOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port buffersOut.
 
void dataInDeallocate_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port dataInDeallocate.
 
void dataOut_out (FwIndexType portNum, Fw::Buffer &fwBuffer)
 Invoke output port dataOut.
 
Fw::Buffer dataOutAllocate_out (FwIndexType portNum, U32 size)
 Invoke output port dataOutAllocate.
 
Fw::SerializeStatus portOut_out (FwIndexType portNum, Fw::SerializeBufferBase &buffer)
 Invoke output port portOut.
 
- Protected Member Functions inherited from Fw::PassiveComponentBase
 PassiveComponentBase (const char *name)
 Named constructor.
 
virtual ~PassiveComponentBase ()
 Destructor.
 
void init (NATIVE_INT_TYPE instance)
 Initialization function.
 
NATIVE_INT_TYPE getInstance () const
 
- Protected Member Functions inherited from Fw::ObjBase
 ObjBase (const char *name)
 ObjBase constructor.
 
virtual ~ObjBase ()
 Destructor.
 
void init ()
 Object initializer.
 

Detailed Description

Definition at line 20 of file GenericHubComponentImpl.hpp.

Member Enumeration Documentation

◆ HubType

HubType:

Type of serialized data on the wire. Allows for expanding them on the opposing end.

Enumerator
HUB_TYPE_PORT 

Port type transmission.

HUB_TYPE_BUFFER 

Buffer type transmission.

HUB_TYPE_EVENT 

Event transmission.

HUB_TYPE_CHANNEL 

Telemetry channel type.

HUB_TYPE_MAX 

Definition at line 27 of file GenericHubComponentImpl.hpp.

Constructor & Destructor Documentation

◆ GenericHubComponentImpl()

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

Construct object GenericHub

Parameters
compNameThe component name

Definition at line 27 of file GenericHubComponentImpl.cpp.

◆ ~GenericHubComponentImpl()

Svc::GenericHubComponentImpl::~GenericHubComponentImpl ( )

Destroy object GenericHub

Definition at line 29 of file GenericHubComponentImpl.cpp.

Member Data Documentation

◆ GENERIC_HUB_DATA_SIZE

const U32 Svc::GenericHubComponentImpl::GENERIC_HUB_DATA_SIZE = 1024
static

Definition at line 35 of file GenericHubComponentImpl.hpp.


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